Not logged in. · Lost password · Register
Forum: Community dokuwiki.org RSS
Help improving the plugin pages
Making us of the plugin survey data
Avatar
andi (Administrator) #1
User title: splitbrain
Member since May 2006 · 3179 posts · Location: Berlin Germany
Group memberships: Administrators, Members
Show profile · Link to this post
Subject: Help improving the plugin pages
A lot of functionality in DokuWiki is achieved by plugins, so they are a very important aspect of the system.

Håkan Sandell took the time to write a script to analyze all existing plugins and their documentation to find out where improvements should be made. This gives us the opportunity to approach these improvements in a very structured way. The findings of his survey are available here: Plugin Survey 2009. Take the time to read through it - it has a lot of interesting info.

Now we need your help to make use of the data. The good thing is that you don't need any programming knowledge for most of the tasks.

Here are a few ideas on what you could do:

  • Update pages for Plugins without a package to use the new downloadable code block syntax. Eg change
    <code>...</code>
    to
    <code php syntax.php>...</code>
  • Try to fix broken download links by finding the correct link, contacting the author or finding someone who still has the code (eg. by asking in the forum)
  • Clean up the pages of bundled plugins by updating the tags, adding usage guides and removing comments/questions and integrate answers into the documentation
  • Add compatibility infos. If you are using a plugin with a certain DokuWiki version just add the version to the compatibility field.
  • Clean up the plugin pages by updating the tags, adding usage guides and removing comments/questions and integrate answers into the documentation

If you have questions on how to approach one of the mentioned tasks or want to do something else, just reply to this thread.
Read this if you don't get any useful answers.
Lies dies wenn du keine hilfreichen Antworten bekommst.
This post was edited on 2009-09-16, 12:42 by andi.
Avatar
dma_k #2
User title: Dmitry Katsubo
Member since Aug 2008 · 40 posts
Group memberships: Members
Show profile · Link to this post
Proposal: also allow the code2 plugin syntax (which I am using), which is slightly extended, but still almost compatible:

<code javascript|h script.js source code|h>
Avatar
HåkanS #3
Member since May 2009 · 85 posts · Location: Stockholm, Sweden
Group memberships: Members, Newsletter Team, Wiki Managers
Show profile · Link to this post
[[devel:events_list]] update done
Avatar
dma_k #4
User title: Dmitry Katsubo
Member since Aug 2008 · 40 posts
Group memberships: Members
Show profile · Link to this post
Are there any concrete remarks (per plugin) about what should be improved in it's description/implementation? E.g. who can make a code review? I am interested, because I also own a plugin and I want to increase it's quality, but haven't got any feedback (yet). I am pretty sure, it can't be perfect.
Avatar
andi (Administrator) #5
User title: splitbrain
Member since May 2006 · 3179 posts · Location: Berlin Germany
Group memberships: Administrators, Members
Show profile · Link to this post
dma_k for questions regarding your code you should ask at the mailinglist. For improving plugin pages in general there are a few things that can be done:

  • remove user questions and include answers to the questions in the plugin documentation
  • add screenshot where useful
  • make sure there is a good description what the plugin does
  • check if a download is available and works, if not provide one if you can
Read this if you don't get any useful answers.
Lies dies wenn du keine hilfreichen Antworten bekommst.
Avatar
rsterbal #6
Member since Sep 2015 · 4 posts
Group memberships: Members
Show profile · Link to this post
Do you need any help getting the word out about DokuWiki on social media?
Close Smaller – Larger + Reply to this post:
Verification code: VeriCode Please enter the word from the image into the text field below. (Type the letters only, lower case is okay.)
Smileys: :-) ;-) :-D :-p :blush: :cool: :rolleyes: :huh: :-/ <_< :-( :'( :#: :scared: 8-( :nuts: :-O
Special characters:
Go to forum
Imprint
This board is powered by the Unclassified NewsBoard software, 20150713-dev, © 2003-2015 by Yves Goergen
Current time: 2017-10-24, 00:38:40 (UTC +02:00)