Template:Infobox/doc: Difference between revisions

Newer edit →

VisualWikitext

@@ Line 1: / Line 1: @@
-{{dochead}}
+== Usage ==
-{{todo|inline=1| Documentation }}
+=== Basic usage ===
+Rows in an infobox can be added by adding parameters <code><nowiki>Header N</nowiki></code> and <code><nowiki>Row N</nowiki></code>. Up to 30 rows can be added, each with a separate header and data entry.
+{{Infobox
+|Title=3/2
+|Header 1 = Size in cents
+|Data 1 = 701.9¢
+|Header 2 = Common name(s)
+|Data 2 = Just perfect 5th
+|Header 3 = Harmonic entropy
+|Data 3 = 3.42385 bits
+}}
+<pre>{{Infobox
+|Title=3/2
+|Header 1 = Size in cents
+|Data 1 = 701.9¢
+|Header 2 = Common name(s)
+|Data 2 = Just perfect 5th
+|Header 3 = Harmonic entropy
+|Data 3 = 3.42385 bits
+}}</pre>
+{{clear}}
+=== Left and right links ===
+Basic navigation can be added by including <code><nowiki>Left Link</nowiki></code> and <code><nowiki>Right Link</nowiki></code>.
+{{Infobox
+|Title=12edo
+|Header 1 = Size of fifth
+|Data 1 = 700¢
+|Header 2 = Size of step
+|Data 2 = 100¢
+|Left Link = &larr; 11edo
+|Right Link = 13edo &rarr;
+}}
+Note that links are ''not'' automatically formatted.
+<pre>{{Infobox
+|Title=12edo
+|Header 1 = Size of fifth
+|Data 1 = 700¢
+|Header 2 = Size of step
+|Data 2 = 100¢
+|Left Link = &larr; 11edo
+|Right Link = 13edo &rarr;
+}}</pre>
+{{Clear}}
+=== Omitting links ===
+Links can be omitted, such as with border cases.
+{{Infobox
+|Title=Prime Limit 2
+|Right Link = 3-limit &rarr;
+}}
+<pre>{{Infobox
+|Title=Prime Limit 2
+|Right Link = 3-limit &rarr;
+}}</pre>
+{{Clear}}
+=== Upper and lower links ===
+Additional navigation can be added by including any of the following: <code><nowiki>Upper Left Link</nowiki></code>, <code><nowiki>Upper Link</nowiki></code>, <code><nowiki>Upper Right Link</nowiki></code>, <code><nowiki>Lower Left Link</nowiki></code>, <code><nowiki>Lower Link</nowiki></code>, and <code><nowiki>Lower Right Link</nowiki></code>. As with the left and right links, links can be omitted.
+{{Infobox
+|Title=5L 2s
+|Header 1 = Generator
+|Data 1 = 685.7¢ to 720¢
+|Header 2 = Basic tuning
+|Data 2 = 12edo (gen = 700¢)
+|Left Link = &larr; 5L 1s
+|Right Link = 5L 3s &rarr;
+|Upper Link = &uarr; 4L 2s
+|Lower Link = &darr; 6L 2s
+}}
+<pre>{{Infobox
+|Title=5L 2s
+|Header 1 = Generator
+|Data 1 = 685.7¢ to 720¢
+|Header 2 = Basic tuning
+|Data 2 = 12edo (gen = 700¢)
+|Left Link = &larr; 5L 1s
+|Right Link = 5L 3s &rarr;
+|Upper Link = &uarr; 4L 2s
+|Lower Link = &darr; 6L 2s
+}}</pre>
+{{Clear}}
+=== Headerless rows ===
+A row that only contains a <code><nowiki>Data N</nowiki></code> entry and no corresponding <code><nowiki>Header N</nowiki></code> is interpreted as a headerless row. This can be used as separators for grouping related information or for information that does not require a header, such as external links.
+{{Infobox
+|Title=5L 2s
+|Data 1 = Generator information
+|Header 2 = Bright gen
+|Data 2 = 685.7¢ to 720¢
+|Header 3 = Dark gen
+|Data 3 = 480¢ to 514.3¢
+|Data 4 = Tunings
+|Header 5 = Hard tuning
+|Data 5 = 17edo (gen = 705.9¢)
+|Header 6 = Basic tuning
+|Data 6 = 12edo (gen = 700¢)
+|Header 7 = Soft tuning
+|Data 7 = 19edo (gen = 694.7¢)
+|Data 30 = Listen on Xenpaper
+|Left Link = &larr; 5L 1s
+|Right Link = 5L 3s &rarr;
+|Upper Link = &uarr; 4L 2s
+|Lower Link = &darr; 6L 2s
+}}
+<pre>{{Infobox
+|Title=5L 2s
+|Data 1 = Generator information
+|Header 2 = Bright gen
+|Data 2 = 685.7¢ to 720¢
+|Header 3 = Dark gen
+|Data 3 = 480¢ to 514.3¢
+|Data 4 = Tunings
+|Header 5 = Hard tuning
+|Data 5 = 17edo (gen = 705.9¢)
+|Header 6 = Basic tuning
+|Data 6 = 12edo (gen = 700¢)
+|Header 7 = Soft tuning
+|Data 7 = 19edo (gen = 694.7¢)
+|Data 30 = Listen on Xenpaper
+|Left Link = &larr; 5L 1s
+|Right Link = 5L 3s &rarr;
+|Upper Link = &uarr; 4L 2s
+|Lower Link = &darr; 6L 2s
+}}}</pre>
+{{Clear}}
 === See also ===
 * {{modlink}}