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

From Biowikifarm Metawiki
Jump to: navigation, search
Line 12: Line 12:
 
=== Usage ===
 
=== Usage ===
  
−
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. Please switch into edit or view mode using the tab on top of the screen to see the "code" calling the templates.
  
 
{{SingleAccessKey | id = MainKey | title = Example in German (links to German Wikipedia) |
 
{{SingleAccessKey | id = MainKey | title = Example in German (links to German Wikipedia) |
Line 27: Line 27:
  
  
−
{{SingleAccessKey | id = Key2 | title = An English Key with backlinks and footnotes (links to English Wikipedia)|
+
{{SingleAccessKey | id = Key2 | title = Start of 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 42: Line 42:
 
{{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 -->}}
 +
----
 +
<small><references/></small>
  
  
−
Note: the single access keys may be strictly dichotomous (two alternatives, as above) or polytomous (some couplets having more than 2 alternatives, not shown). Furthermore, it is possible to design keys in statement-style (as above) or in question-answer-style as follows:
+
Single access keys created with these templates may be strictly '''dichotomous''' (two alternatives, as above) or they may be '''polytomous''' (some couplets having more than 2 alternatives, not shown). Furthermore, it is possible to design keys in statement-style (as above) or in question-answer-style as follows:
  
−
{{SingleAccessKey | id = KeyQA | title = Example of a key in question-answer-style|
+
{{SingleAccessKey | id = KeyQA | title = Example of the start of a key in question-answer-style|
 
{{LeadQuestion | 1    | What is the life form of your plant? }}
 
{{LeadQuestion | 1    | What is the life form of your plant? }}
 
{{Lead | a  | a tree, shrub, or a woody climber > 50 cm high| 2 }}
 
{{Lead | a  | a tree, shrub, or a woody climber > 50 cm high| 2 }}
Line 55: Line 57:
 
<!-- end of single-access key -->}}
 
<!-- end of single-access key -->}}
  
−
----
+
 
−
<small><references/></small>
+
For testing, also a technical sample of a reticulated key, resulting in a Directed Acyclical Graph (this key is complete, no dangling leads as in the other examples):
 +
 
 +
<small>
 +
{{SingleAccessKey | id = KeyDAG | title = Techical example containing reticulation (Lead 4 has two parents, 3 and 6|
 +
{{Lead | 1| statement a| 2 }}
 +
{{Lead | 1| statement b| 3 }}
 +
{{Lead | 2| statement a| ''Sambucus racemosa''}}
 +
{{Lead | 2| statement b| 5 }}
 +
{{Lead | 3| statement a| 6}}
 +
{{Lead | 3| statement b| 4}}
 +
{{Lead | 4| statement a| ''Acer negundo''}}
 +
{{Lead | 4| statement b| ''Fraxinus excelsior''}}
 +
{{Lead | 5| statement a| ''Rubus fruticosus'' }}
 +
{{Lead | 5| statement b| ''Ribes nigrum''}}
 +
{{Lead | 6| statement a| 4}}
 +
{{Lead | 6| statement b| ''Rubus ideus''}}
 +
<!-- end of single-access key -->}}
 +
</small>
  
 
===TODO===
 
===TODO===

Revision as of 07:55, 25 October 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. Please switch into edit or view mode using the tab on top of the screen to see the "code" calling the templates.

Example in German (links to German Wikipedia)
Start of an English Key with backlinks and footnotes (links to English Wikipedia)


Single access keys created with these templates may be strictly dichotomous (two alternatives, as above) or they may be polytomous (some couplets having more than 2 alternatives, not shown). Furthermore, it is possible to design keys in statement-style (as above) or in question-answer-style as follows:

Example of the start of a key in question-answer-style
For testing, also a technical sample of a reticulated key, resulting in a Directed Acyclical Graph (this key is complete, no dangling leads as in the other examples):
Techical example containing reticulation (Lead 4 has two parents, 3 and 6
</small>

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.