Difference between revisions of "Wiki Development Checklist"

From Audacity Wiki
Jump to: navigation, search
(Wiki extensions.)
(few comments, mainly on image links)
Line 28: Line 28:
 
*<font color="#FF3300">(W)</font> It would be nice if you could choose to be notified (by the yellow flash when you log in) not only when your user talk page is modified, but when any page you are watching is modified.  Otherwise you have to rely on the email service, or hang out on recent changes or on your watch list.  
 
*<font color="#FF3300">(W)</font> It would be nice if you could choose to be notified (by the yellow flash when you log in) not only when your user talk page is modified, but when any page you are watching is modified.  Otherwise you have to rely on the email service, or hang out on recent changes or on your watch list.  
 
*<font color="#FF3300">(W)</font> Uploading and playing audio media (including MP3 if possible). Are there any security implications?   
 
*<font color="#FF3300">(W)</font> Uploading and playing audio media (including MP3 if possible). Are there any security implications?   
* {{external|[http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi Syntax highlighting]}}
 
 
* adding {{external|[http://www.mediawiki.org/wiki/Texvc texvc]}} so we can support <nowiki><math></nowiki> tags. Also see {{external|1=[http://www.darkmatters.org/forums/index.php?showtopic=5895 this discussion]}}.  
 
* adding {{external|[http://www.mediawiki.org/wiki/Texvc texvc]}} so we can support <nowiki><math></nowiki> tags. Also see {{external|1=[http://www.darkmatters.org/forums/index.php?showtopic=5895 this discussion]}}.  
 
* Tables - Either install the {{external|[http://www.mediawiki.org/wiki/Extension:TableEdit TableEdit]}} extension or add standard MediaWiki support for a Tables button on the Edit Toolbar. If the latter is done, add superscript and subscript buttons in the Edit Toolbar as well.
 
* Tables - Either install the {{external|[http://www.mediawiki.org/wiki/Extension:TableEdit TableEdit]}} extension or add standard MediaWiki support for a Tables button on the Edit Toolbar. If the latter is done, add superscript and subscript buttons in the Edit Toolbar as well.
Line 45: Line 44:
 
*Can't easily make images clickable other than to the internal image description page. There are workrounds for internal links (e.g. put a redirect on the image description page and hide the redirection text), and there are (hard to use) image map extensions you can install that allow linking to article pages, but no easy workrounds GA is aware of for links outside the Wiki.
 
*Can't easily make images clickable other than to the internal image description page. There are workrounds for internal links (e.g. put a redirect on the image description page and hide the redirection text), and there are (hard to use) image map extensions you can install that allow linking to article pages, but no easy workrounds GA is aware of for links outside the Wiki.
 
**<font color="green">James: This restriction has been discussed on media wiki.  
 
**<font color="green">James: This restriction has been discussed on media wiki.  
**Gale: Can you post a link if you know of a useful discussion?   </font>
+
**Gale: Can you post a link if you know of a useful discussion?  
**James: The link I found called it a feature request, but here's a solution that could work for us which I found by another route: [http://www.mediawiki.org/wiki/Extension:ImageMap Extension:ImageMap].  This will do the 'Audacity for the Impatient'.  The glossary items need [http://www.mediawiki.org/wiki/Extension:Icon Extension:Icon] or [http://www.mediawiki.org/wiki/Extension:LinkedImage Extension:LinkedImage], assuming these can handle off-site links or failing that an [http://www.mediawiki.org/wiki/Extension:AllowAnchorTags Extension:AllowAnchorTags] variant that's documented on that page.
+
**James: The link I found called it a feature request, but here's a solution that could work for us which I found by another route: [http://www.mediawiki.org/wiki/Extension:ImageMap Extension:ImageMap].  This will do the 'Audacity for the Impatient'.  The glossary items need [http://www.mediawiki.org/wiki/Extension:Icon Extension:Icon] or [http://www.mediawiki.org/wiki/Extension:LinkedImage Extension:LinkedImage], assuming these can handle off-site links or failing that an [http://www.mediawiki.org/wiki/Extension:AllowAnchorTags Extension:AllowAnchorTags] variant that's documented on that page.</font>
 
+
**<font color="#990033">Gale: I'd found '''ImageMap''' before and it looked complex on first sight (and I had not looked properly). I had been trying a template-based solution instead to see if we could avoid adding extensions. I think those inexperienced with co-ordinates would have to use it with the {{external|1=[http://tools.wikimedia.de/~dapete/ImageMapEdit/ImageMapEdit.html?en Image Map editor tool]}} if they were building image maps. That tool makes it pretty easy. I've tested it and it does work with external links (with a bug that links containing "&" won't work plus a few others). It would also work very simply out of the box for the Glossary by setting the co-ordinates to the full image (rect 0 0 100 100). I think '''Icon''' supports external links but it is not vital to have it as well. '''Linked Image''' does not support external links, but it may be worth having for internal links as its tag makes it obvious what it does. So '''AllowAnchorTags''' possibly isn't needed, but I presume it would get round the "$" bug in ImageMap. I think the extensions we agree on should go on both Wikis. </font>
 
 
  
  
Line 63: Line 61:
 
* [http://www.mediawiki.org/wiki/Extension_Matrix The wikimedia Extensions Matrix] lists available extensions.  Some we might consider (stable unless indicated otherwise) are:
 
* [http://www.mediawiki.org/wiki/Extension_Matrix The wikimedia Extensions Matrix] lists available extensions.  Some we might consider (stable unless indicated otherwise) are:
 
** [http://www.mediawiki.org/wiki/Extension:SecureHTML SecureHtml] - Arbitrary html on sysops locked template pages.
 
** [http://www.mediawiki.org/wiki/Extension:SecureHTML SecureHtml] - Arbitrary html on sysops locked template pages.
** [http://www.mediawiki.org/wiki/Extension:AllowAnchorTags AllowAnchorTags] - A particular example is hrefs around an image.
+
** [http://www.mediawiki.org/wiki/Extension:AllowAnchorTags AllowAnchorTags] - A particular example is hrefs around an image. <i> see also comments above about clickable images</i>
** [http://www.mediawiki.org/wiki/Extension:CategoryTree CategoryTree] - (for this wiki) Categories as a clickable tree.
+
**<font color="#FF3300">(W)</font> [http://www.mediawiki.org/wiki/Extension:CategoryTree CategoryTree] - Categories as a clickable tree.
** [http://www.mediawiki.org/wiki/Extension:EmailAddressImage EmailAddressImage] - e-mail addresses converted to images.
+
** [http://www.mediawiki.org/wiki/Extension:EmailAddressImage EmailAddressImage] - e-mail addresses converted to images. <i> Naturally the address can't be copied to clipboard so of limited value - probably better to add underscores in the address and a mailto: as we do now? </i>
** [http://www.mediawiki.org/wiki/Extension:GeSHiCodeTag GeSHiCodeTag] - Code syntax highlighting.  Think we have this already.
+
** [http://www.mediawiki.org/wiki/Extension:GeSHiCodeTag GeSHiCodeTag] - Code syntax highlighting.  Or the similar {{external|[http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi SyntaxHighlight_GeSHi]}}
 
** [http://www.mediawiki.org/wiki/Extension:Glossary Glossary] - Automated tooltips for glossary items placed on a special sysops locked page.  Need to see an example to see whether this is good or not!
 
** [http://www.mediawiki.org/wiki/Extension:Glossary Glossary] - Automated tooltips for glossary items placed on a special sysops locked page.  Need to see an example to see whether this is good or not!
 
** [http://www.mediawiki.org/wiki/Extension:Hierarchy Hierarchy] - Seems to be good for showing where you are in a 'book', providing forward and backward buttons.
 
** [http://www.mediawiki.org/wiki/Extension:Hierarchy Hierarchy] - Seems to be good for showing where you are in a 'book', providing forward and backward buttons.
Line 72: Line 70:
 
** <font color="orange">[http://www.mediawiki.org/wiki/Extension:OggHandler Ogg Handler] - '''BETA Ogg Vorbis.'''</font>
 
** <font color="orange">[http://www.mediawiki.org/wiki/Extension:OggHandler Ogg Handler] - '''BETA Ogg Vorbis.'''</font>
 
** [http://www.mediawiki.org/wiki/Extension:Translate Translate] - To facilitate translation?  Possibly it's only for translation of MediaWiki itself?
 
** [http://www.mediawiki.org/wiki/Extension:Translate Translate] - To facilitate translation?  Possibly it's only for translation of MediaWiki itself?
** <font color="orange">[http://www.mediawiki.org/wiki/Extension:Tree_view Tree View] - '''BETA Possibly nice for contents?  (requires javascript?  Only of use on live site?)'''</font>
+
** <font color="orange">[http://www.mediawiki.org/wiki/Extension:Tree_view Tree View] - '''BETA Possibly nice for contents?  (requires javascript?  Only of use on live site?) <i>Maybe nice to replace the links in the Sidebar</i></font>
  
  
  
 
== Done ==
 
== Done ==

Revision as of 08:23, 8 January 2008


This page is for discussion of ideas for developing both this Wiki and the Manual Wiki , and for monitoring progress of these developments. Relevant topics include security issues, bug fixes and enhanced functionality through installing additional extensions.

The points noted apply to both Wiki and Manual Wiki unless marked (W) for this Wiki only, or (M) for Manual Wiki only. Please move items to the Done section of this page when agreed changes have been implemented.


Security

  • (W) reCAPTCHA  has been implemented for this Wiki for new user registration and in the event of "brute-force" password cracking. It's also implemented for anonymous edits that contain new external links, but currently anonymous editing is already disabled - if you try to edit without being logged in you get "You have to log in to edit pages". Given the protection above, should we relax this restriction? Would it encourage more useful edits than we have now? Manual Wiki is already locked down so that all registrations are pre-approved by a sysop.
    • Buanzo votes "yes, allow anonymous editing on a trial basis on the main Wiki". Gale would go along with it if others strongly agree. Anyone else?
  • GA will write some help text for users who have difficulty with reCAPTCHA and provide some alternative registration method. ReCAPTCHA would seem to offer some difficulties for blind users, even though an audio file can be played to hear a set of digits to enter. For example, you can't tab into the place where you click for the audio file, and the ALT text "Get an audio challenge" over the audio button is hardly clear what it means. Similarly you can't tab to the Help button. GA will also seek further advice from CMU as to the options for navigating without a mouse.
  • Is there any automated way of removing inactive/blocked accounts? There are relatively few active users, but dozens of inactive/blocked ones which make it difficult to find "real" users.
  • Should there be some way of recording the IP address of account holders - or is this hidden somewhere?
  • System pages (Special:Allmessages) are in Special pages for all users so anyone could change them. Should they not be in Restricted Special Pages?
  • A Regex spam filter is needed for standard text, not just links in text.


Translations

  • (M) Some mechanism is needed to (at the least) translate the 1.4.0 Manual, and ultimately also important Wiki documents that are linked to in our FAQs. There is a strong case for moving the FAQs themselves into the Manual Wiki where they can be updated more easily, the only real argument against which is the current lack of a translation mechanism. Crude "online-only" solutions would seem to be possible even now, e.g. create translated pages with an appropriate suffix and link to them on a translated Manual home page with the same suffix.
    Obviously the shell is in English, so would you get round that by creating a new domain using a translated shell, or something like that? Is there some way to automatically create duplicates for existing pages with various suffixes? What about issues exporting and converting to HTML only a subset of Manual pages for the particular language?


Feature Enhancements

  • Multiple file upload at a time 
  • (W) It would be nice if you could choose to be notified (by the yellow flash when you log in) not only when your user talk page is modified, but when any page you are watching is modified. Otherwise you have to rely on the email service, or hang out on recent changes or on your watch list.
  • (W) Uploading and playing audio media (including MP3 if possible). Are there any security implications?
  • adding texvc  so we can support <math> tags. Also see this discussion .
  • Tables - Either install the TableEdit  extension or add standard MediaWiki support for a Tables button on the Edit Toolbar. If the latter is done, add superscript and subscript buttons in the Edit Toolbar as well.


Restrictions and Possible bugs

  • Bug (in MediaWiki?) : cannot upload files with .png extension but have to change it to PNG. GIF is blocked, is it a real security risk?
    • James: GIF is a proprietary format. I'm fine with us continuing to block it.
    • Gale: GIF is now open - the worldwide patents owned by Compuserve expired in 2004. There is no good reason to block it that I'm aware of - there are plenty of GIF images on Wikipedia, and this is an un-necessary inconvenience.
  • Bug (in MediaWiki?) : <span style="line-height"> tags rejected as spam though this string is not in our current filters.
  • (M) Unable to scale images with normal syntax of "[[Image.png|60px]]"
  • Can't easily make images clickable other than to the internal image description page. There are workrounds for internal links (e.g. put a redirect on the image description page and hide the redirection text), and there are (hard to use) image map extensions you can install that allow linking to article pages, but no easy workrounds GA is aware of for links outside the Wiki.
    • James: This restriction has been discussed on media wiki.
    • Gale: Can you post a link if you know of a useful discussion?
    • James: The link I found called it a feature request, but here's a solution that could work for us which I found by another route: Extension:ImageMap. This will do the 'Audacity for the Impatient'. The glossary items need Extension:Icon or Extension:LinkedImage, assuming these can handle off-site links or failing that an Extension:AllowAnchorTags variant that's documented on that page.
    • Gale: I'd found ImageMap before and it looked complex on first sight (and I had not looked properly). I had been trying a template-based solution instead to see if we could avoid adding extensions. I think those inexperienced with co-ordinates would have to use it with the Image Map editor tool  if they were building image maps. That tool makes it pretty easy. I've tested it and it does work with external links (with a bug that links containing "&" won't work plus a few others). It would also work very simply out of the box for the Glossary by setting the co-ordinates to the full image (rect 0 0 100 100). I think Icon supports external links but it is not vital to have it as well. Linked Image does not support external links, but it may be worth having for internal links as its tag makes it obvious what it does. So AllowAnchorTags possibly isn't needed, but I presume it would get round the "$" bug in ImageMap. I think the extensions we agree on should go on both Wikis.


Alternatives to MediaWiki

  • Is MediaWiki the best software, and if not are the problems porting to another Wiki insuperable? For example, it's only one feature, but Dokuwiki  (GPL) supports images being clickable links to any external page you like. A feature list comparing DokuWiki with MediaWiki is here . That table says MediaWiki supports "image links" but it does not seem to do so out of the box.
    • James: I'd be very wary of trying to move at this stage because of the time cost in fixing up 'minor differences'. Clickable images would be nice to have for the Glossary in the Manual. For the downloaded manual we can add them in a post-processing stage. We can live without them for the live site.
    • Gale: I think we should be on the look out for workrounds, as this is a considerable restriction. It also makes our image in "Audacity for the Impatient" (currently only being considered for the online Manual) close to useless IMO.


Extensions rather than Alternatives

  • The wikimedia Extensions Matrix lists available extensions. Some we might consider (stable unless indicated otherwise) are:
    • SecureHtml - Arbitrary html on sysops locked template pages.
    • AllowAnchorTags - A particular example is hrefs around an image. see also comments above about clickable images
    • (W) CategoryTree - Categories as a clickable tree.
    • EmailAddressImage - e-mail addresses converted to images. Naturally the address can't be copied to clipboard so of limited value - probably better to add underscores in the address and a mailto: as we do now?
    • GeSHiCodeTag - Code syntax highlighting. Or the similar SyntaxHighlight_GeSHi 
    • Glossary - Automated tooltips for glossary items placed on a special sysops locked page. Need to see an example to see whether this is good or not!
    • Hierarchy - Seems to be good for showing where you are in a 'book', providing forward and backward buttons.
    • Pdf Export - PDF Export.
    • Ogg Handler - BETA Ogg Vorbis.
    • Translate - To facilitate translation? Possibly it's only for translation of MediaWiki itself?
    • Tree View - BETA Possibly nice for contents? (requires javascript? Only of use on live site?) Maybe nice to replace the links in the Sidebar


Done