Difference between revisions of "Template:Documentation"

From yidtravel
Jump to: navigation, search
 
Line 1: Line 1:
−
his template is used to display a color-coded map of regions and a legend with the region color, name and description. Use of this template is as follows:
+
<div style="clear:both;margin:1em 0;border:1px solid #aaa;background:#ecfcf4;padding:.5em" class="template-documentation"><!--
−
<no
+
  
−
{{{Regionlist
+
These are the literal class definitions in common.css:
−
| regionmap=The name of the region map
+
−
| regionmaptext=Text to display under the map image
+
/* For template documentation */
−
| regionmapsize=The size of the map in px. Defaults to 350px if not passed
+
.template-documentation {
−
| region1name=The name of the first region
+
    clear: both;
−
| region1color=The HTML color code to use in the legend for the first region
+
    margin: 1em 0 0 0;
−
| region1items=An optional list of items to appear in parentheses next to the region name
+
    border: 1px solid #aaa;
−
| region1description=A description of the region
+
    background: #ecfcf4;
−
}}
+
    padding: .5em;
−
The parameters above should be repeated for additional regions, but replace "region1" with "region2", "region3", etc. An example usage of this template with real data follows (descriptions have been truncated for readability):
+
}
  
−
{{{Regionlist
+
-->{{#ifeq:{{{heading|μ}}}|<!--**DEFINED BUT EMPTY**-->
−
| regionmap=Map-USA-Regions01.png
+
  |<!--**NOTHING**-->
−
| regionmaptext=Regions of the USA
+
  |<div style="padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex">{{#ifeq:{{{content|μ}}}|μ
−
| regionmapsize=300px
+
    |<span class="mw-editsection plainlinks" id="doc_editlinks" style="float:right; margin-right:0.50em;">{{#ifexist:{{{1|{{Documentation/docname}}}}}
−
| region1name=[[California]]
+
    |<!--**    /doc EXISTE**  -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}}} view]] [[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]] [[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history]] [{{purge|purge}}]  
−
| region1color=#e0fa92
+
    |<!--**/doc NÃO EXISTE**-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload=Template:Documentation/preload}} create]]
−
| region1items=
+
    }}</span>
−
| region1description=In some ways quintessentially American, and in...
+
  }} <span style="{{#if:{{{heading-style|}}}|{{{heading-style}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|font-weight:bold;font-size:125%|font-size:150%}}}}">{{#if:{{{heading|}}}|{{{heading}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|[[Image:Template-info.svg|50px]] Template documentation|Documentation}}}}</span></div>
−
| region2name=[[Pacific Northwest (United States of America)|Pacific Northwest]]
+
}}<!--
−
| region2color=#38911c
+
 
−
| region2items=[[Washington (state)|Washington]], [[Oregon]]
+
--><div id="template_doc_page_transcluded" class="dablink plainlinks"><!--
−
| region2description=The pleasantly mild Pacific Northwest offers...
+
 
−
}}
+
  -->{{#ifexist:{{{1|{{Documentation/docname}}}}}
 +
  |<!--**/doc EXISTS**-->This documentation is transcluded from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])<br />'''''Note to editors:''' Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.''</small><br /><!--
 +
  -->}}<!--
 +
 
 +
  -->{{#switch:{{SUBPAGENAME}}
 +
  |sandbox|testcases=<!--**DO NOT SHOW THESE LINKS ON THE SANDBOX/TESTCASES PAGES**-->
 +
  |#default=
 +
    {{#switch:{{SUBJECTSPACE}}
 +
    |{{ns:template}}
 +
    |{{ns:user}}=
 +
      {{#ifexist:{{FULLPAGENAME}}/sandbox
 +
      |This template has a [[/sandbox|sandbox]] <small style="font-style:normal">([{{fullurl:{{#rel2abs:/sandbox}}|action=edit}} edit])</small> <!--
 +
        -->{{#ifexist:{{FULLPAGENAME}}/testcases
 +
        |and [[/testcases|testcases]] <small style="font-style:normal">([{{fullurl:{{#rel2abs:/testcases}}|action=edit}} edit])</small>}} for editors to experiment.
 +
      |{{#ifexist: {{FULLPAGENAME}}/testcases
 +
        |This template has [[/testcases|testcases]] <small style="font-style:normal">([{{fullurl:{{#rel2abs:/testcases}}|action=edit}} edit])</small> for editors to experiment.}}
 +
  }}}}}}
 +
</div>
 +
{{#if:{{{content|}}}|{{{content|}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}}|{{ {{{1|{{Documentation/docname}}}}}}}}}}}
 +
<div style="clear:both;"></div>
 +
</div><noinclude>
 +
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 +
</noinclude>

Latest revision as of 15:00, 20 March 2015

[[{{fullurl:Template:Documentation/docname|action=edit&preload=Template:Documentation/preload}} create]] 50px Template documentation
Retrieved from "http://yidtravel.com/mw/index.php?title=Template:Documentation&oldid=14619"