Difference between revisions of "Template:Documentation/MasterTOC"

Revision as of 20:39, 1 July 2018

{{{booktitle}}}

{{{toccontent}}}

[[{{{NextPage}}}|Next Page

>]]

Usage of Parameters

ShowPrevPage: set to "block" to show the "previous page" link, set to "none" to hide it. This parameter is not set in the TOC based on this template, but rather in the file containing that TOC. So the parameter value is "passed through" the TOC to this template and therefore must explicitly be set to none to hide the link. The TOC must use {{{ShowPrevPage}}} as the parameter value to ensure passing along.
PrevPage: the path to the previous page (no surrounding "[")
ShowNextPage: set to "block" to show the "next page" link, set to "none" to hide it. This parameter is not set in the TOC based on this template, but rather in the file containing that TOC. So the parameter value is "passed through" the TOC to this template and therefore must explicitly be set to none to hide the link. The TOC must use {{{ShowNextPage}}} as the parameter value to ensure passing along.
NextPage: the path to the previous page (no surrounding "[")
bookid: The id for the book (not yet evaluated)
booktitle: The book title that appears at the top of the TOC in full wiki syntax (i.e. as a link: [[MyGuide|My Great Manual]]
ShowParttitle: set to "block" to show the part title. This will be used in Sub-TOCs. It will default to hidden when not specified.
parttitle: The title of the part that this Sub-TOC covers in full wiki syntax (i.e. as a link: [[MyGuide/MyPart|Part 1: My Great Part]]
toccontent: The content of the TOC as lists and divs.
ShowPrevPart: set to "block" in to show the "previous part" link at the bottom of the TOC. If this parameter is set at the TOC level (and not on the file level like the prev/next page parameter), it will default to hidden when not specified.
PrevPart: the path to the first page of the previous part (no surrounding "[")
ShowNextPart: set to "block" in to show the "previous part" link at the bottom of the TOC. If this parameter is set at the TOC level (and not on the file level like the prev/next page parameter), it will default to hidden when not specified.
NextPart: the path to the first page of the next part (no surrounding "[")

The style classes are not yet created in the css file

Simulated example

ShowPrevPage set to none
ShowNextPage set to block
NextPage set to The Next Page
bookid set to 1234
booktitle set to [[My Manual]]
ShowParttitle set to block
parttitle set to [[The First Part]]
ShowPrevPart set to none
ShowNextPart set to block
NextPart set to The Second Part
toccontent set to * Chapter
* Chapter
* Chapter

My Manual

The First Part

Next Part >

Chapter
Chapter
Chapter

Next Page >

Calculated example

(note: not usable in preview mode while editing this template):

{{Documentation/MasterTOC
|ShowPrevPage=none
|ShowNextPage=block
|NextPage=The Next Page
|bookid=1234'''
|booktitle=[[My Manual]]
|ShowParttitle=block
|parttitle=[[The First Part]]
|ShowPrevPart=none
|ShowNextPart=block
|NextPart=The Second Part
|toccontent=* Chapter
* Chapter
* Chapter
}}

will be:

My Manual

The First Part

Next Section >

Chapter
Chapter
Chapter

Next Page >

@@ Line 1: / Line 1: @@
-<div id="PrevNextPage" class="docooo_prevnextpage" style="font-size: xx-small!important; margin-bottom: 10px;">
+<div id="tocwrapper" clear:both; class="docooo_tocwrapper" style="float:right;  width: 200px; padding: 0px; border: 3px solid #fff; border-left: 20px solid #fff; border-bottom: 20px solid #fff; margin-left: 40px; margin-bottom: 20px; margin-top: -5px;">
+<!--
+  <div id="icon" style="float:right; margin-right: -10px; margin-top: -10px;">[[Image:Book.png]]</div>
+//-->
+  <div id="{{{bookid}}}" style="border:1px solid #9BC0F5; padding: 0px; font-size: xx-small; background-color: #FFF;">
+    <div id="doc_toctitle" class="docooo_toctitle docsection">{{{booktitle}}}</div>
+    <div id="parttitle" class="docooo_parttitle" style="padding: 1px;font-weight: bold; text-align: left; border-bottom: 1px solid #9099a8; display:{{{ShowParttitle|none}}}">
+: {{{parttitle}}}
+ <div id="tocfooter" class="docooo_tocfooter" style="padding: 1px;">
 {|border=0 width=100%
 |-
-|style="text-align:left;"|<span style="display: {{{ShowPrevPage|none}}}">[[{{{PrevPage}}}|&lt; Previous Page]]</span>
+|style="text-align:left;"|<span style="display: {{{ShowPrevPart|none}}}">[[{{{PrevPart}}}|&lt; {{Documentation/TOC/TOC_{{{Lang|en}}}|Previous Section}}]]</span>
-|style="text-align:right;"|<span style="display: {{{ShowNextPage|none}}}">[[{{{NextPage}}}|Next Page &gt;]]</span>
+|style="text-align:right;"|<span style="display: {{{ShowNextPart|none}}}">[[{{{NextPart}}}|{{Documentation/TOC/TOC_{{{Lang|en}}}|Next Section}} &gt;]]</span>
 |}
 </div>
+</div>
-<div id="tocwrapper" class="docooo_tocwrapper" style="float:right;  width: 200px; padding: 0px; border: 3px solid #fff; border-left: 20px solid #fff; border-bottom: 20px solid #fff; margin-left: 40px; margin-bottom: 20px; margin-top: -5px;">
-  <div id="icon" style="float:right; margin-right: -10px; margin-top: -10px;">[[Image:Book.png]]</div>
-  <div id="{{{bookid}}}" style="border:1px solid #9099a8; padding: 0px; font-size: xx-small; background-color: #FFF;">
-    <div id="toctitle" class="docooo_toctitle" style="background-color: #c5d0e1; border: 0px solid #9099a8; padding: 1px;font-weight: bold; text-align: center; font-size:120%;">{{{booktitle}}}</div>
-    <div id="parttitle" class="docooo_parttitle" style="padding: 1px;font-weight: bold; text-align: center; border-bottom: 1px solid #9099a8; display:{{{ShowParttitle|none}}}">{{{parttitle}}}</div>
      <div id="tocbody" class="docooo_tocbody" style="padding: 6px;">
 {{{toccontent}}}
      </div>
- <div id="tocfooter" class="docooo_tocfooter" style="padding: 1px;">
+<div id="PrevNextPage" class="docooo_prevnextpage" style="font-size: xx-small!important; margin-bottom: 3px; margin-top: 3px;">
 {|border=0 width=100%
 |-
-|style="text-align:left;"|<span style="display: {{{ShowPrevPart|none}}}">[[{{{PrevPart}}}|&lt; Previous Part]]</span>
+|style="text-align:left;"|<span style="display: {{{ShowPrevPage|none}}}">[[{{{PrevPage}}}|&lt; {{Documentation/TOC/TOC_{{{Lang|en}}}|Previous Page}}]]</span>
-|style="text-align:right;"|<span style="display: {{{ShowNextPart|none}}}">[[{{{NextPart}}}|Next Part &gt;]]</span>
+|style="text-align:right;"|<span style="display: {{{ShowNextPage|none}}}">[[{{{NextPage}}}|{{Documentation/TOC/TOC_{{{Lang|en}}}|Next Page}} &gt;]]</span>
 |}
 </div>
@@ Line 42: / Line 45: @@
 ;NextPart:the path to the first page of the next part (no surrounding "[")
-{{Documentation/Note|The style classes are not yet created in the css file}}
+{{Note|The style classes are not yet created in the css file}}
+=== Simulated example ===
-===Example===
 * '''ShowPrevPage''' set to '''none'''
 * '''ShowNextPage''' set to '''block'''
@@ Line 54: / Line 58: @@
 * '''ShowPrevPart''' set to '''none'''
 * '''ShowNextPart''' set to '''block'''
-* '''NextPart''' set to '''<nowiki>[[The Second Part]]</nowiki>'''
+* '''NextPart''' set to '''The Second Part'''
+* '''toccontent''' set to '''* Chapter<br /> * Chapter<br /> * Chapter'''
 <div style="border: 1px dotted #000; padding: 20px; width: 400px; margin: 20px;">
-<div id="PrevNextPage" class="docooo_prevnextpage" style="font-size: small; margin-bottom: 10px;">
-{|border=0 width=100%
-|-
-|style="text-align:left;"|<span style="display: none">[[{{{PrevPage}}}|&lt; Previous Page]]</span>
-|style="text-align:right;"|<span style="display: block">[[The Next Page|Next Page &gt;]]</span>
-|}
-</div>
 <div id="tocwrapper" class="docooo_tocwrapper" style="width: 200px; padding: 0px; border: 5px solid #fff;">
    <div id="icon" style="float:right; margin-right: -10px; margin-top: -10px;">[[Image:Book.png]]</div>
    <div id="1234" style="border:1px solid #9099a8; padding: 0px; font-size: xx-small; background-color: #FFF;">
-     <div id="toctitle" class="docooo_toctitle" style="background-color: #c5d0e1; border: 0px solid #9099a8; padding: 1px;font-weight: bold; text-align: center; font-size:120%;">[[My Manual]]</div>
+     <div id="toctitle" class="docooo_toctitle" style="background-color: #c5d0e1; border: 0px solid #9099a8; padding: 1px;font-weight: bold; text-align: left; font-size:120%;">[[My Manual]]</div>
-     <div id="parttitle" class="docooo_parttitle" style="padding: 1px;font-weight: bold; text-align: center; border-bottom: 1px solid #9099a8; display:block">[[My First Part]]</div>
+     <div id="parttitle" class="docooo_parttitle" style="padding: 1px;font-weight: bold; text-align: left; border-bottom: 1px solid #9099a8; display:block">
+: [[The First Part]]
+</div>
+ <div id="tocfooter" class="docooo_tocfooter" style="padding: 1px;">
+{|border=0 width=100%
+|-
+|style="text-align:left;"|<span style="display: {{{ShowPrevPart|none}}}">[[{{{PrevPart}}}|&lt; Previous Part]]</span>
+|style="text-align:right;"|<span style="display: block">[[The Second Part|Next Part &gt;]]</span>
+|}
+</div>
      <div id="tocbody" class="docooo_tocbody" style="padding: 6px;">
 * Chapter
@@ Line 75: / Line 82: @@
 * Chapter
      </div>
- <div id="tocfooter" class="docooo_tocfooter" style="padding: 1px;">
+<div id="PrevNextPage" class="docooo_prevnextpage" style="font-size: small; margin-bottom: 10px;">
 {|border=0 width=100%
 |-
-|style="text-align:left;"|<span style="display: {{{ShowPrevPart|none}}}">[[{{{PrevPart}}}|&lt; Previous Part]]</span>
+|style="text-align:left;"|<span style="display: none">[[{{{PrevPage}}}|&lt; Previous Page]]</span>
-|style="text-align:right;"|<span style="display: {{{ShowNextPart|none}}}">[[{{{NextPart}}}|Next Part &gt;]]</span>
+|style="text-align:right;"|<span style="display: block">[[The Next Page|Next Page &gt;]]</span>
 |}
 </div>
@@ Line 86: / Line 93: @@
 </div>
+===Calculated example===
+(note: not usable in preview mode while editing this template):
+<pre>{{Documentation/MasterTOC
+|ShowPrevPage=none
+|ShowNextPage=block
+|NextPage=The Next Page
+|bookid=1234'''
+|booktitle=[[My Manual]]
+|ShowParttitle=block
+|parttitle=[[The First Part]]
+|ShowPrevPart=none
+|ShowNextPart=block
+|NextPart=The Second Part
+|toccontent=* Chapter
+* Chapter
+* Chapter
+}}
+</pre>
+will be:
+<div style="border: 1px dotted #000; padding: 20px; width: 400px; height: 200px; margin: 20px;">
+{{Documentation/MasterTOC
+|ShowPrevPage=none
+|ShowNextPage=block
+|NextPage=The Next Page
+|bookid=1234'''
+|booktitle=[[My Manual]]
+|ShowParttitle=block
+|parttitle=[[The First Part]]
+|ShowPrevPart=none
+|ShowNextPart=block
+|NextPart=The Second Part
+|toccontent=* Chapter
+* Chapter
+* Chapter
+}}
+</div>
+</noinclude>
+<noinclude>
+[[Category:Documentation/Templates]]
+[[Category:Exclude in print|{{PAGENAME}}]]
+[[Category:Wiki Templates for Navigation]]
 </noinclude>

Difference between revisions of "Template:Documentation/MasterTOC"

Revision as of 20:39, 1 July 2018

Usage of Parameters

Simulated example

Calculated example

Views

Personal tools

Navigation

Search

Tools