Difference between revisions of "Template:Documentation/MasterTOC"
From Apache OpenOffice Wiki
(to more understanding TOC structure headers it must look as tree section) |
(page navigation under page TOC, part navigation under part TOC. And inline example) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<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="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="icon" style="float:right; margin-right: -10px; margin-top: -10px;">[[Image:Book.png]]</div> | ||
| Line 14: | Line 6: | ||
: {{{parttitle}}} | : {{{parttitle}}} | ||
</div> | </div> | ||
| − | |||
| − | |||
| − | |||
<div id="tocfooter" class="docooo_tocfooter" style="padding: 1px;"> | <div id="tocfooter" class="docooo_tocfooter" style="padding: 1px;"> | ||
{|border=0 width=100% | {|border=0 width=100% | ||
| Line 22: | Line 11: | ||
|style="text-align:left;"|<span style="display: {{{ShowPrevPart|none}}}">[[{{{PrevPart}}}|< Previous Part]]</span> | |style="text-align:left;"|<span style="display: {{{ShowPrevPart|none}}}">[[{{{PrevPart}}}|< Previous Part]]</span> | ||
|style="text-align:right;"|<span style="display: {{{ShowNextPart|none}}}">[[{{{NextPart}}}|Next Part >]]</span> | |style="text-align:right;"|<span style="display: {{{ShowNextPart|none}}}">[[{{{NextPart}}}|Next Part >]]</span> | ||
| + | |} | ||
| + | </div> | ||
| + | <div id="tocbody" class="docooo_tocbody" style="padding: 6px;"> | ||
| + | {{{toccontent}}} | ||
| + | </div> | ||
| + | <div id="PrevNextPage" class="docooo_prevnextpage" style="font-size: xx-small!important; margin-bottom: 10px;"> | ||
| + | {|border=0 width=100% | ||
| + | |- | ||
| + | |style="text-align:left;"|<span style="display: {{{ShowPrevPage|none}}}">[[{{{PrevPage}}}|< Previous Page]]</span> | ||
| + | |style="text-align:right;"|<span style="display: {{{ShowNextPage|none}}}">[[{{{NextPage}}}|Next Page >]]</span> | ||
|} | |} | ||
</div> | </div> | ||
| Line 46: | Line 45: | ||
{{Documentation/Note|The style classes are not yet created in the css file}} | {{Documentation/Note|The style classes are not yet created in the css file}} | ||
| − | === | + | === Simulated example === |
* '''ShowPrevPage''' set to '''none''' | * '''ShowPrevPage''' set to '''none''' | ||
* '''ShowNextPage''' set to '''block''' | * '''ShowNextPage''' set to '''block''' | ||
| Line 56: | Line 55: | ||
* '''ShowPrevPart''' set to '''none''' | * '''ShowPrevPart''' set to '''none''' | ||
* '''ShowNextPart''' set to '''block''' | * '''ShowNextPart''' set to '''block''' | ||
| − | * '''NextPart''' set to ''' | + | * '''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 style="border: 1px dotted #000; padding: 20px; width: 400px; margin: 20px;"> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<div id="tocwrapper" class="docooo_tocwrapper" style="width: 200px; padding: 0px; border: 5px solid #fff;"> | <div id="tocwrapper" class="docooo_tocwrapper" style="width: 200px; padding: 0px; border: 5px solid #fff;"> | ||
| Line 73: | Line 66: | ||
<div id="parttitle" class="docooo_parttitle" style="padding: 1px;font-weight: bold; text-align: left; border-bottom: 1px solid #9099a8; display:block"> | <div id="parttitle" class="docooo_parttitle" style="padding: 1px;font-weight: bold; text-align: left; border-bottom: 1px solid #9099a8; display:block"> | ||
: [[My First Part]] | : [[My 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}}}|< Previous Part]]</span> | ||
| + | |style="text-align:right;"|<span style="display: block">[[The Second Part|Next Part >]]</span> | ||
| + | |} | ||
</div> | </div> | ||
<div id="tocbody" class="docooo_tocbody" style="padding: 6px;"> | <div id="tocbody" class="docooo_tocbody" style="padding: 6px;"> | ||
| Line 79: | Line 79: | ||
* Chapter | * Chapter | ||
</div> | </div> | ||
| − | + | <div id="PrevNextPage" class="docooo_prevnextpage" style="font-size: small; margin-bottom: 10px;"> | |
{|border=0 width=100% | {|border=0 width=100% | ||
|- | |- | ||
| − | |style="text-align:left;"|<span style="display: | + | |style="text-align:left;"|<span style="display: none">[[{{{PrevPage}}}|< Previous Page]]</span> |
| − | |style="text-align:right;"|<span style="display: | + | |style="text-align:right;"|<span style="display: block">[[The Next Page|Next Page >]]</span> |
|} | |} | ||
</div> | </div> | ||
| Line 89: | Line 89: | ||
</div> | </div> | ||
| + | </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> | </div> | ||
</noinclude> | </noinclude> | ||
Revision as of 13:25, 29 May 2008
{{{booktitle}}}
{{{toccontent}}}
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 "[")
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
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:
