Difference between revisions of "Template:Key Start/doc"

From Biowikifarm Metawiki
Jump to: navigation, search
(New page: {{Documentation/subpage}} === Highlights=== * Without expert intervention, users can duplicate any existing key and modify, translate, or shorten it. * It is possible to rearrange the ke...)
 
Line 14: Line 14:
 
The templates [[Template:SingleAccessKey]] and [[Template:Lead]] are to be used in combination.
 
The templates [[Template:SingleAccessKey]] and [[Template:Lead]] are to be used in combination.
  
−
{{SingleAccessKey | id = MainKey | title = Example in German |
+
{{SingleAccessKey | id = MainKey | title = Example in German (links to German Wikipedia) |
 
{{Lead | 1 | Blätter [http://de.wikipedia.org/wiki/Phyllotaxis#Grundtypen gegenständig]  |  2 }}
 
{{Lead | 1 | Blätter [http://de.wikipedia.org/wiki/Phyllotaxis#Grundtypen gegenständig]  |  2 }}
 
{{Lead | 1 | Blätter [http://de.wikipedia.org/wiki/Phyllotaxis#Grundtypen wechselständig]  |  18 }}
 
{{Lead | 1 | Blätter [http://de.wikipedia.org/wiki/Phyllotaxis#Grundtypen wechselständig]  |  18 }}
Line 26: Line 26:
  
  
−
{{SingleAccessKey | id = Key2 | title = An English Key with backlinks |
+
{{SingleAccessKey | id = Key2 | title = An English Key with backlinks and footnotes (links to English Wikipedia)|
 
{{Lead | 1    | Trees, shrubs, or woody climbers > 50 cm high| 2 }}
 
{{Lead | 1    | Trees, shrubs, or woody climbers > 50 cm high| 2 }}
 
{{Lead | 1    | Herbs or small shrubs (< 50 cm high) | 17 }}
 
{{Lead | 1    | Herbs or small shrubs (< 50 cm high) | 17 }}
Line 36: Line 36:
 
{{Lead | 4    | Leaves not lobed | 6 }}
 
{{Lead | 4    | Leaves not lobed | 6 }}
 
{{Lead | 5 (4)| Leaves pinnately-veined. Fruit an acorn. Tree  | [http://en.wikipedia.org/wiki/Quercus_robur ''Quercus robur''] L. }}
 
{{Lead | 5 (4)| Leaves pinnately-veined. Fruit an acorn. Tree  | [http://en.wikipedia.org/wiki/Quercus_robur ''Quercus robur''] L. }}
−
{{Lead | 5    | Leaves palmately-veined. Fruit fleshy. Small shrub  | [[Ribes nigrum|''Ribes nigrum'' L.]] }}
+
{{Lead | 5    | Leaves palmately-veined. Fruit fleshy. Small shrub  | [[Ribes nigrum|Blackcurrant ''Ribes nigrum'' L.]]<ref>Blackcurrant juice is used for jams, sirup (French ''Cassis'')</ref>}}
 
{{Lead | 6 (4)| Leaves compound. Fruit a red mulberry | ''Rubus ideus'' L. subsp. ''idaeus'' }}
 
{{Lead | 6 (4)| Leaves compound. Fruit a red mulberry | ''Rubus ideus'' L. subsp. ''idaeus'' }}
 
{{Lead | 6    | Leaves entire. Fruit not mulberry-like | 7 }}
 
{{Lead | 6    | Leaves entire. Fruit not mulberry-like | 7 }}
 
<!-- end of single-access key -->}}
 
<!-- end of single-access key -->}}
 +
 +
<references/>
  
 
===TODO===
 
===TODO===

Revision as of 10:36, 24 September 2008

This is a documentation subpage for Template:Key Start (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Highlights

  • Without expert intervention, users can duplicate any existing key and modify, translate, or shorten it.
  • It is possible to rearrange the key or add new couplets or leads with new taxa.
    • In both cases, renumbering the leads is a problem, but while building a key up, non-consecutive lead numbers can be an interim solution.
  • Both lead statements and taxon links can contain links to internal wiki pages or external web pages, defining or explaining characters, states, or taxa.
  • Manually added images are possible, not yet present in current demonstration

Usage

The templates Template:SingleAccessKey and Template:Lead are to be used in combination.

Example in German (links to German Wikipedia)
An English Key with backlinks and footnotes (links to English Wikipedia)

TODO

  • Add the key id to each lead id, to support multiple keys on a wikipage. Work on this was started, but not finished!
  • A fourth parameter should be added to handle images in a template-defined way. Where would they be placed best in such a key?
  • Improvements: The key title could be displayed better than as caption, a description parameter could be added.
  • A FRIDA html key for comparison. One major difference is that FRIDA always places the taxon in a row of its own.

Known problems

  1. A plain three column layout is less than satisfactory; the occasional wide taxon names force the whole last column to be very wide.
    • To some extent, this is already worked around by providing a four-column layout with alternating colspan (33% of table width is assigned to statement, if no taxon is present, or to taxon, if that is present. However, this still means that the statement may be presented shorter than necessary.
  2. Clicking on the hyperlinks usually has no effect if the screen already contains the target lead.
    • Proposed solution: some javascript additions. Note: JS can not be called directly from within the wiki text for security reasons, or any user could reprogram the wiki into a dangerous tool.
  3. Leads do not automatically renumber.
    • There is an obvious service solutions for this: The project would have to program a "bot" program, the works through all keys that have a category like "Please renumber" set, renumbering the key in an optimal way, and then deleting (or commenting out) the category.
  4. There are no lead dots running from the statement to the number.
    • Attempting to fix this with <span style="float:right"> . . . .</span> did not work well!
    • Can this be fixed with a repeated background image and non-transparent text? Could be worth testing!


Dependencies

Currently this depends on some styles in MediaWiki:Common.css, one of which refers to a background image which must be available, and it needs the StringFunctions extension installed. It requires several templates to be installed. The central template being Template:Lead, other templates: Template:Trim, Template:SingleAccessKey/doc, Template:Lead/doc, Template:Documentation, Template:Documentation/subpage, Template:Documentation/docname, Template:Documentation/preload.

Retrieved from "https://biowikifarm.net/metawiki/index.php?title=Template:Key_Start/doc&oldid=114"