Difference between revisions of "Template:Lead"

From Species-ID
Jump to: navigation, search
m (inline display as <div> for occurrence, remarks, description including last line break, <span> HTML containing complex stuff gets broken)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<noinclude>Version 2.0: Creating a shell for a Lead/Inner template, which can pass calculated fields like the parsed lead-ID a single time.
+
<noinclude>{{Documentation}}
−
 
+
−
{{Documentation}}
+
−
 
+
 
[[Category:Single-access key templates]]
 
[[Category:Single-access key templates]]
 +
</noinclude><includeonly><!--
 +
// First parse leadID, see http://offene-naturfuehrer.de/web/Vorlage:Lead/SplitNumberV2 for development notices:
 +
-->{{
 +
#vardefine: leadIDParenthesisPos|{{#pos:{{{1}}}|(}}}}{{
 +
#vardefine: leadIDMain|{{#replace:{{#replace:{{#replace:{{{1|Couplet_ID_missing!}}}|-|–}}|'|’}}|*|&#42;}}}}{{
 +
#vardefine: backlink|}}{{
 +
#if: {{#var: leadIDParenthesisPos}}|{{
 +
  #vardefine: backlink|{{#if:alwaystrue-to-trim|{{#replace:{{#sub:{{#var: leadIDMain}}|{{#expr:{{#var: leadIDParenthesisPos}}+1 }}<!--end sub/repl/trim/vardef:-->}}|)|}} }}}}{{
 +
  #vardefine: leadIDMain|{{#if:alwaystrue-to-trim|{{#sub:{{#var: leadIDMain}} | 0 |{{#var: leadIDParenthesisPos}} }} }}}}
 +
}}<!-- // end if leadIDParenthesisPos.
  
−
</noinclude><includeonly>{{Lead/Inner
+
// Now split the leadIDMain into coupletID and withinCoupletID (=alternativeID). First determine splitting position:
−
| keyID      ={{#var:SingleAccessKeyID}}}}
+
-->{{#vardefine: leadIDSplitPos|{{#pos:{{#var: leadIDMain}}|&#42;}}}}{{#if: {{#var: leadIDSplitPos}}|<!--nothing,
−
| leadID  ={{Lead/SplitNumber|{{{1|99999}}}|0|noformatting=1}}
+
else:-->|{{#vardefine: leadIDSplitPos|{{#pos:{{#var: leadIDMain}}|–}}}}{{#if: {{#var: leadIDSplitPos}}|<!--nothing,
−
| displayID  ={{Lead/SplitNumber|{{{1|Number missing!}}}|0}}
+
else:-->|{{#vardefine: leadIDSplitPos|{{#pos:{{#var: leadIDMain}}|’}}}}{{#if: {{#var: leadIDSplitPos}}|<!--nothing,
−
| leadpart2 ={{Lead/SplitNumber|{{{1}}}|1}}
+
else:-->|{{#vardefine: leadIDSplitPos|{{#pos:{{#var: leadIDMain}}|<nowiki> </nowiki>}}}}{{#if: {{#var: leadIDSplitPos}}|<!--nothing,
 +
else:-->|{{#vardefine: leadIDSplitPos|{{#len:{{#if: true|{{#var: leadIDMain}}}}}}}}}}<!--
 +
close 3x if: -->}}}}}}<!--
 +
// Now use leadIDSplitPos to split part 1 and part 2:
 +
-->{{#vardefine: coupletID| {{#sub:{{#var: leadIDMain}}| 0 |{{#var: leadIDSplitPos}}<!--end sub+vardef:-->}}}}{{
 +
    #vardefine: withinCoupletID| {{#sub:{{#var: leadIDMain}}|{{#var: leadIDSplitPos}}}}}}{{Lead/Inner
 +
| subheading = {{{subheading|}}}
 +
| subheadingstyle = {{{subheadingstyle|}}}
 +
| IDprefix  =L{{#var:decisiontreeID}}_{{#replace:{{#replace:{{#replace:{{{parentlead|}}}|-|–}}|'|’}}|*|&#42;}}
 +
| leadIDbacklink ={{#var: backlink}}
 +
| coupletID      ={{#var: coupletID}}
 +
| withinCoupletID ={{#var: withinCoupletID}}
 +
| parentlead ={{{parentlead|}}}
 +
| nested    ={{#if:alwaystrue-to-trim|{{{nested|}}}}}
 
| statement  ={{{2|'''Lead statement missing!'''}}}
 
| statement  ={{{2|'''Lead statement missing!'''}}}
−
| nextlead  ={{{3|}}}
+
| next      ={{#if:alwaystrue-to-trim|{{{3|}}}}}
−
| commonnames={{{commonnames|}}}
+
| commonnames={{#replace: {{{commonnames|}}}{{{common names|}}}|;|,}}
−
| result    ={{{result|}}}
+
| scientificname={{{scientific name|}}}
−
| errors    =<!--ERROR REPORTING: Any content in 4th and later unnamed parameters is an error.-->{{#if: {{{4|}}}{{{commonname|}}}{{{image|}}}{{{images|}}}<!--
+
−
THEN:-->|Error: You may have an erroneous 4th unnamed parameter (vertical bar without a field name), or you may use "commonname/image/images" instead of "commonnames/image 1a" etc. The content is: {{{4|}}} {{{5|}}} {{{commonname|}}} {{{image|}}} {{{images|}}}. To add images or descriptions use <code><nowiki>|description=Your text|</nowiki></code> ''and'' <code><nowiki>|image 1a=Image:YourImage.jpg |caption 1a=Your Caption</nowiki></code>.<!--END ERROR REPORTING.-->}}
+
 
| synonyms  ={{{synonyms|}}}
 
| synonyms  ={{{synonyms|}}}
−
| description={{{description|}}}
+
| resultqualifier ={{{result qualifier|}}}{{{resultqualifier|}}}<!-- always possible, e.g. "male", "L.", “2 species“ -->
−
| occurrence ={{{occurrence|}}}
+
| resulttextoverride ={{{result text|}}}{{{resulttext|}}}
−
| remarks   ={{{remarks|}}}
+
| resulttext ={{#if: {{{result text|}}}{{{resulttext|}}}<!--
−
| images 1 width  ={{{images 1 width|180}}}
+
// then-->|{{{result text|}}}{{{resulttext|}}}<!--
−
| images 1 height ={{{images 1 height|180}}}
+
// else-->|{{#if: {{{scientific name|}}} |{{{scientific name|}}}|{{{result|}}}}}
−
| images 1 resize ={{{images 1 resize|1}}}
+
}}
−
| image 1a       ={{{image 1a|}}}
+
| resultlink ={{StripFormatting|1={{#if: {{{result|}}} |{{{result|}}}|{{{scientific name|}}}}} }}
−
| caption 1a     ={{{caption 1a|}}}
+
| errors    =<!--ERROR REPORTING: Content in 4th and ff unnamed parameters is error.-->{{
−
| image 1a width  ={{{image 1a width|}}}
+
#if: {{{4|}}}{{{5|}}}{{{commonname|}}}{{{common name|}}}{{{image|}}}{{{images|}}}{{{synonym|}}}{{{remark|}}}{{{results|}}}<!--
−
| image 1a height ={{{image 1a height|}}}
+
THEN:-->|[[Category:Internal - Error in Lead template]]Error: You may have an erroneous 4th unnamed parameter (vertical bar without a field name), or you may use "commonname/common name/remark/results/synonym/image/images" instead of "common names/remarks/result/synonyms/image a" etc. The content is: '''{{{4|}}} {{{5|}}} {{{commonname|}}} {{{common name|}}} {{{synonym|}}} {{{remark|}}} {{{results|}}} {{{image|}}} {{{images|}}}'''. To add descriptions use <code><nowiki>|description=Your text|</nowiki></code>; to add one or several synonyms use <code><nowiki>|synonmys=Synonym 1; Synonym 2|</nowiki></code>; to add images use <code><nowiki>|image 1a=Image:YourImage.jpg |caption 1a=Your Caption</nowiki></code> (images a to e are in the sidebar, j following below lead text, with j/k always visible and, images m to r in the "more"-information area below the lead).<!--
−
| image 1b       ={{{image 1b|}}}
+
END ERROR REPORTING.
−
| caption 1b     ={{{caption 1b|}}}
+
START DETAIL TEXT:-->}}
−
| image 1b width  ={{{image 1b width|}}}
+
| detailtext ={{
−
| image 1b height ={{{image 1b height|}}}
+
#if: {{{synonyms|}}} |<span class="synonyms">(= {{{synonyms}}})</span><br />
−
| image 1c       ={{{image 1c|}}}
+
}}{{
−
| caption 1c     ={{{caption 1c|}}}
+
#if: {{{description|}}} |<div class="description" style="display:inline">{{{description}}}
−
| image 1c width  ={{{image 1c width|}}}
+
</div>
−
| image 1c height ={{{image 1c height|}}}
+
}}{{
−
| image 1d       ={{{image 1d|}}}
+
#if: {{{occurrence|}}} |<div class="occurrence" style="display:inline">{{{occurrence}}}
−
| caption 1d     ={{{caption 1d|}}}
+
</div>
−
| image 1d width  ={{{image 1d width|}}}
+
}}{{
−
| image 1d height ={{{image 1d height|}}}
+
#if: {{{remarks|}}} |<div class="remarks" style="display:inline">{{{remarks}}}
−
| gallerytype ={{{gallerytype|wrap}}}
+
</div>
 +
}}<!--END DETAIL TEXT. Next short version: detailtext or image m following present:-->
 +
| detailspresent ={{#sub:{{{synonyms|}}}{{{description|}}}{{{occurrence|}}}{{{remarks|}}}{{{image m|}}}|0|1}}
 +
| primary images width  ={{{primary images width|100}}}
 +
| primary images height ={{{primary images height|100}}}
 +
| image a        ={{{image a|}}}
 +
| label a        ={{{label a|}}}
 +
| caption a      ={{{caption a|}}}
 +
| image a width  ={{{image a width|{{{primary images width|100}}}}}}
 +
| image a height ={{{image a height|{{{primary images height|100}}}}}}
 +
| image b       ={{{image b|}}}
 +
| label b        ={{{label b|}}}
 +
| caption b     ={{{caption b|}}}
 +
| image b width  ={{{image b width|{{{primary images width|100}}}}}}
 +
| image b height ={{{image b height|{{{primary images height|100}}}}}}
 +
| image c       ={{{image c|}}}
 +
| label c        ={{{label c|}}}
 +
| caption c     ={{{caption c|}}}
 +
| image c width  ={{{image c width|{{{primary images width|100}}}}}}
 +
| image c height ={{{image c height|{{{primary images height|100}}}}}}
 +
| image d       ={{{image d|}}}
 +
| label d        ={{{label d|}}}
 +
| caption d     ={{{caption d|}}}
 +
| image d width  ={{{image d width|{{{primary images width|100}}}}}}
 +
| image d height ={{{image d height|{{{primary images height|100}}}}}}
 +
| image e       ={{{image e|}}}
 +
| label e        ={{{label e|}}}
 +
| caption e     ={{{caption e|}}}
 +
| image e width  ={{{image e width|{{{primary images width|100}}}}}}
 +
| image e height ={{{image e height|{{{primary images height|100}}}}}}
 +
| extra images width ={{{extra images width|200}}}
 +
| extra images height ={{{extra images height|200}}}
 +
| image j        ={{{image j|}}}
 +
| label j        ={{{label j|}}}
 +
| caption j      ={{{caption j|}}}
 +
| image j width  ={{{image j width|600}}}
 +
| image j height ={{{image j height|400}}}
 +
| image k        ={{{image k|}}}
 +
| label k        ={{{label k|}}}
 +
| caption k      ={{{caption k|}}}
 +
| image k width  ={{{image k width|600}}}
 +
| image k height ={{{image k height|400}}}
 +
| image m        ={{{image m|}}}
 +
| label m        ={{{label m|}}}
 +
| caption m      ={{{caption m|}}}
 +
| image m width  ={{{image m width|{{{extra images width|200}}}}}}
 +
| image m height ={{{image m height|{{{extra images height|200}}}}}}
 +
| image n        ={{{image n|}}}
 +
| label n        ={{{label n|}}}
 +
| caption n      ={{{caption n|}}}
 +
| image n width  ={{{image n width|{{{extra images width|200}}}}}}
 +
| image n height ={{{image n height|{{{extra images height|200}}}}}}
 +
| image o        ={{{image o|}}}
 +
| label o        ={{{label o|}}}
 +
| caption o      ={{{caption o|}}}
 +
| image o width  ={{{image o width|{{{extra images width|200}}}}}}
 +
| image o height ={{{image o height|{{{extra images height|200}}}}}}
 +
| image p        ={{{image p|}}}
 +
| label p        ={{{label p|}}}
 +
| caption p      ={{{caption p|}}}
 +
| image p width  ={{{image p width|{{{extra images width|200}}}}}}
 +
| image p height ={{{image p height|{{{extra images height|200}}}}}}
 +
| image q        ={{{image q|}}}
 +
| label q        ={{{label q|}}}
 +
| caption q      ={{{caption q|}}}
 +
| image q width  ={{{image q width|{{{extra images width|200}}}}}}
 +
| image q height ={{{image q height|{{{extra images height|200}}}}}}
 +
| image r        ={{{image r|}}}
 +
| label r        ={{{label r|}}}
 +
| caption r      ={{{caption r|}}}
 +
| image r width  ={{{image r width|{{{extra images width|200}}}}}}
 +
| image r height ={{{image r height|{{{extra images height|200}}}}}}
 +
| captionlines ={{{captionlines|3}}}
 
| imagesfooter ={{{imagesfooter|}}}
 
| imagesfooter ={{{imagesfooter|}}}
−
| captionlines ={{{captionlines|2}}}
 
−
| images 2 width  ={{{images 2 width|180}}}
 
−
| images 2 height ={{{images 2 height|180}}}
 
−
| images 2 resize ={{{images 2 resize|1}}}
 
−
| image 2a        ={{{image 2a|}}}
 
−
| caption 2a      ={{{caption 2a|}}}
 
−
| image 2a width  ={{{image 2a width|}}}
 
−
| image 2a height ={{{image 2a height|}}}
 
−
| image 2b        ={{{image 2b|}}}
 
−
| caption 2b      ={{{caption 2b|}}}
 
−
| image 2b width  ={{{image 2b width|}}}
 
−
| image 2b height ={{{image 2b height|}}}
 
−
| image 2c        ={{{image 2c|}}}
 
−
| caption 2c      ={{{caption 2c|}}}
 
−
| image 2c width  ={{{image 2c width|}}}
 
−
| image 2c height ={{{image 2c height|}}}
 
−
| image 2d        ={{{image 2d|}}}
 
−
| caption 2d      ={{{caption 2d|}}}
 
−
| image 2d width  ={{{image 2d width|}}}
 
−
| image 2d height ={{{image 2d height|}}}
 
−
| image 2e        ={{{image 2e|}}}
 
−
| caption 2e      ={{{caption 2e|}}}
 
−
| image 2e width  ={{{image 2e width|}}}
 
−
| image 2e height ={{{image 2e height|}}}
 
−
| image 2f        ={{{image 2f|}}}
 
−
| caption 2f      ={{{caption 2f|}}}
 
−
| image 2f width  ={{{image 2f width|}}}
 
−
| image 2f height ={{{image 2f height|}}}
 
−
| image 2g        ={{{image 2g|}}}
 
−
| caption 2g      ={{{caption 2g|}}}
 
−
| image 2g width  ={{{image 2g width|}}}
 
−
| image 2g height ={{{image 2g height|}}}
 
−
| image 2h        ={{{image 2h|}}}
 
−
| caption 2h      ={{{caption 2h|}}}
 
−
| image 2h width  ={{{image 2h width|}}}
 
−
| image 2h height ={{{image 2h height|}}}
 
−
| image 2i        ={{{image 2i|}}}
 
−
| caption 2i      ={{{caption 2i|}}}
 
−
| image 2i width  ={{{image 2i width|}}}
 
−
| image 2i height ={{{image 2i height|}}}
 
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 21:53, 20 April 2017

[edit] [purge] Template-info.svg Template documentation
This documentation is transcluded from Template:Lead/doc. (edit | history)

See Key Start for the main documentation.

Changes in recent versions

(The main documentation for all parts of the single-access key is under Template:Key Start/doc!)

Version 3.9.

  • comments changed, partly refactored
  • removed the br in front of the resultqualifier if sidebar image a etc. present
  • result layout variants better integrated to save memory
  • general minor optimizations
  • next-lead-pointer (number on right side) now always in same row as statement, even if results are also present

Version 3.8.

  • moved from own jKey-collapsible mechanism to MediaWiki’s mw-customcollapsible
  • introduced scientificname and new rules of the result-layout
  • saving properties for commonnames, scientificname, synonyms

Version 3.7.

Length estimate based on resulttext instead of resultlink (for empty result!!!)

Previous changes:

  • nested works now on parents with backlinks and alternatives (1 and 1*, 1 and 1'). 1 and 1- NEEDS TESTING!
  • result text+ empty result supported (non-linking result).
  • nowrap on result/qualifier reworked!
  • result=http:... now works.
  • Nested subkey ok. Resultqualifier no longer in ()
Version 3.3:
  • added scientific name and new layout for result
Version 3.2:
  • Added error category: Category:Internal - Error in Lead template
  • removed: resultlink
  • resulttext deprecated, "result text" is preferred!
  • resultqualifier deprecated, "result qualifier" is preferred!
  • common names allowed (and should perhaps be preferred over commonnames! -- TODO: also allow common names in Key Start

Older version changes:

Nested subkey. STATUS: Tested, result text and image j/k working.

New parameters: nested (the first lead number of a nested key that identifies the current lead as its parentlead. parentlead = identifying a lead as nested within the parentlead (the leads are indented, and the parentlead identifier become part of the nested lead id/next-lead values).

a) Simplified, no more image-no-resize-parameter (manually set size for very small images), no more link to next/result behind image, no more little metadata icons (which were necessary because of redirecting the main links. Javascript runs almost everywhere, former solution was very complicated and removed by javascript code! -- b) new image k, intended to be always displayed (no autohide) BELOW the statement text (for larger, wide in-key images). -- c) obsolete -- d) new parameter "result qualifier=" for male/female/white form, etc.; may also be used for scientific names, if result is desired to link to the common name. -- c) Image numbering adjusted to simplify creating a decision-based template (one template covering all leads, like the decision horizontal template. Called by outer template, Collapsible/collapsed added, lead images in right sidebar (up to five primary, "image a" to "image e", images side-by-side), non-hideable below statement (2 images, "image j"/"image k") and hidable below (secondary, "image m" to "image r" etc, max 6 images, wrapping gallery style).

PROCESS: a) Handle the subheading parameter directly (creating a visual separator (bold) above a couplet, usually summarizing identification progress and highlighting "sections" of a key). b) Error handling and combining detail text already occurs here. c) Call Template:Lead/Inner, passing calculated fields like the parsed lead-ID to be used multiple times.

Additional- and subtemplates

Lead
 ├ Lead/SplitNumber
 ├ Lead/Inner
 ├ Lead/doc
 ├ Lead/GalleryItem
 └ Lead/GalleryItemNoCaption
 + Template: StripFormatting to get just text
 + Template: Pixel2Number eg. 300px → 300


Technical Documentation

Lead/Inner produces a table row with 6 <td> 

Legend:
tr#something → id="something"
td.something → class="something"
{something}  → {{{something}}}
[something]  → optional
‹1-2›        → colspan

┌ tr#L{keyID}_{leadID}_{decisiontreeAlternative}_row ───────────────────┐
│  [td] ┬ if {parentlead}                                               │
│  [td] ┘                                                               │
│  td.dt-nodeid                                                         │
└───────────────────────────────────────────────────────────────────────┘

┌ tr.dt-subheading ─────────────────────────────────────────────────────┐
└───────────────────────────────────────────────────────────────────────┘

┌  tr.dt-row#L{keyID}_{leadID}_row ─────────────────────────────────────┐
│   [td] ┬ if {parentlead}                                              │
│   [td] ┘                                                              │
│   td.dt-nodeid#L{keyID}_{leadID}                                      │
│   td.leadalt                                                          │
│ ┌ td.lead-row1 ─────────────────────────────────────────────────────┐ │
│ │  table.nested                                                     │ │
│ │  ├ tr                                                             │ │
│ │  │  td.leadtext span.leadspan                                     │ │   │   │ ► │
│ │  │  [td.leadresult span.leadon]                                   │ │   
│ │  ├ tr                                                             │ │
│ │  │  td.leadresult                                                 │ │   │       │
│ │  │     span.commonnames                                           │ │
│ │  │     span.leadresults                                           │ │
│ │  │       span.leadout                                             │ │
│ │  │       span.resultqualifier                                     │ │
│ │  │     span.leadon                                                │ │
│ │  ├ tr                                                             │ │
│ │  │  th.leaderror                                                  │ │   │       │
│ │  └ tr                                                             │ │
│ │     td.leadextras                                                 │ │   │       │
│ │       div.leadextras[.mw-collapsible]                             │ │
│ │         table                                                     │ │
│ │          tr                                                       │ │
│ │           table (containing image m,n,o,p,q,r) → Lead/GalleryItem │ │
│ │  table.nested                                                     │ │
│ │  └ tr                                                             │ │
│ │     td                                                            │ │
│ │       div (float:left) image j,k                                  │ │
│ └───────────────────────────────────────────────────────────────────┘ │
│   td                                                                  │
│    table                                                              │
│    tr                                                                 │
│      td (containing image a,b,c,d,e) → Lead/GalleryItemNoCaption      │
│        div.overlaywrapper                                             │
│          div.overlaylabel                                             │
└───────────────────────────────────────────────────────────────────────┘

Notes:

1. The first column contains the lead number plus an anchor (id="") to which internal links may point. Here and further below, the first Lead parameter is split into two parts using the Lead/SplitNumber template.

2. Retrieving the id-parameter of the earlier "Key Start" template from a variable depends on the "Variables" extension being installed. On Wiki installations where this is not the case, remove the template code "{{#var: decisiontreeID}}" (here, in Lead itself and Lead/SplitNumber).

3. Temporarily, the template supports two versions for formatting results, depending on whether Scientific Name is present (new) or not (old). If most keys have a scientific name, then the old version may be dropped. Please attempt to create all new keys for the new format! 

 ############### NEW OLD RESULT layout rules: ####################
 // ? scientificname
 // yes: (new layout format)
 //    ? resulttext
 //    yes: resulttext [, resultlink] [, next]
 //    no :
 //        ? commonnames
 //        yes: commonnames - scientificname [, next]
 //        no : scientificname [, next]
 // no : (old layout)
 //    ? commonnames
 //    yes: commonnames
 //        ? resulttext
 //        yes: commonnames - resulttext [, resultlink] [, next]
 //        no : commonnames [, next]
 // Note: [, next] can appear in all layout variants
 ############################################################
Retrieved from "https://species-id.net/w/index.php?title=Template:Lead&oldid=142606"