[dokuwiki] Re: Improve the repository plugin

  • From: Anika Henke <anika@xxxxxxxxxxxxxxx>
  • To: dokuwiki@xxxxxxxxxxxxx
  • Date: Sun, 04 Oct 2009 17:25:26 +0100

Mykola Ostrovskyy wrote:
AH> If no-one is quicker than me, I intended to go through *all* of the
AH> plugins and adjust the tags to a meaningful set (some time in the future).

Do you by chance have the "meaningful set" written down somewhere?

No, I intended to make that up as I go along with the help of some common sense.

Certain rules which make sense:

* Don't repeat similar words: E.g. the aforementioned "link linking links". Another example is "style style.ini styles stylesheet styling css". Instead just choose one for all of them. * Don't have both singular and plural. Maybe the repository plugin could help here by combining them in a similar way like config:autoplural. Not sure what the preferred grammatical number should be. I guess that highly depends on the word and shouldn't follow a strict rule. E.g. 'toolbar' only makes sense in singular, whereas 'images' or 'tables' probably make more sense in plural. * There shouldn't be many tags which are related to one plugin only, i.e. replace too specific tags with more common tags (or just remove the too specific tags): E.g. don't have 'youtube, sevenload, dailymotion', when only 'video' is the most important bit. Another example is my ABC plugin, which shouldn't use 'abc' while just 'music' is enough. Or 'star' and 'stars' should just have 'rating' and so on. * Only use the most basic words, e.g. use 'collapse' instead of 'collapsible' and 'fold' instead of 'folding'. * While we're at it, we should also check if the tags make sense at all. E.g. the skill plugin shouldn't have a tag 'skill' and the stars plugin neither 'skill' nor 'star' nor 'difficulty'. Or the 'faq' plugin shouldn't be tagged with 'faq' but with 'headline' and 'style' instead. (Let's ignore for now that the names of these plugins are misnomers.)
* Keep tags of similar plugins consistent between each other.
* Delete non-English words.

Phew, I could go on and on ... ;-)

I'm sure, there will also be many exceptions to these rules. So, don't take them too seriously. It's also important to take a look at what each plugin really does and don't just trust their descriptions. ;-)

It makes sense to do all these changes in a short amount of time (at least within one week?) or otherwise the remaining untouched plugins would be disadvantaged. (The only reason why I repeated all those mistakes with my Wrap plugin for example was that I didn't want to have the disadvantage of the plugin missing somewhere where its competitors would be listed.)


Anika
--
DokuWiki mailing list - more info at
http://wiki.splitbrain.org/wiki:mailinglist

Other related posts: