TB Wiki Style Guide for Content Developers: Difference between revisions

Latest revision as of 13:51, 13 May 2022

Page Display Title

It is recommended that

{{DISPLAYTITLE:<title name>}}

is inserted at the start of every article. This will enable you to define a display title that may differ from the url of the article. This will also improve on searches when the title of the page is entered as search criteria.

This article applies to

For all configuration articles, use the following table to show to which product and version the article applies:

This article applies to:	Product	Version
	SBC	3.0

[edit]

To create a page with tabbed content, do the following:

At the top of a page, enter
```
__NOTOC__
```
For every tab header, use one equal sign before and after the header name. Then enter your content. Do not use
==
or
===
for lower level headers.
To make tabbed headers work, at the end of the article enter
```
<headertabs/>
```
If you want to return the user to a tab on another page, and have a specific tab highlighted, enter

{{#switchtablink:<tab name>|<Link text>|<Page Name}}

as in

{{#switchtablink:System|Return to Web Portal 3.1 Home Page|Sbc_Tutorial_Guide_v3.1}}

Use this page as an example of Tabbed Headers

@@ Line 1: / Line 1: @@
+{{DISPLAYTITLE:TB Wiki Content Development Guidelines}}
+__NOTOC__
+=General=
+'''Page Display Title'''
+It is recommended that <pre>{{DISPLAYTITLE:<title name>}}</pre> is inserted at the start of every article. This will enable you to define a display title that may differ from the url of the article. This will also improve on searches when the title of the page is entered as search criteria.
+'''This article applies to'''
+For all configuration articles, use the following table to show to which product and version the article applies:
+{| class="wikitable"
+|-
+|rowspan="3"|This article applies to:
+|'''Product'''
+|'''Version'''
+|-
+|SBC
+|3.0
+|}
 =Header Tabs=
+[[Image:TbWikiStyle1.png]]
+To create a page with tabbed content, do the following:
-[[Image:TB Wiki Style_0]]
-To create a page with tabbed content, do the following:
-* Enter __NOTOC__ at the top of a page
+* At the top of a page, enter <pre>__NOTOC__</pre>
-* For every tab header, use one equal sign before and after the header name. Then enter your content. '''Do not use == or === for lower level headers.'''
+* For every tab header, use one equal sign before and after the header name. Then enter your content. '''Do not use <pre>==</pre> or <pre>===</pre> for lower level headers.'''
-* Place '''<headertabs/>''' at the end of the article.
+* To make tabbed headers work, at the end of the article enter <pre><headertabs/></pre>
-* In the case of the web portal tutorial guide, if you want to retrun the user to the previous page and tab, place this at the bottom of the page.
+* If you want to return the user to a tab on another page, and have a specific tab highlighted, enter
+<pre>{{#switchtablink:<tab name>|<Link text>|<Page Name}}</pre>
+as in
+<pre>{{#switchtablink:System|Return to Web Portal 3.1 Home Page|Sbc_Tutorial_Guide_v3.1}}</pre>
+[[Toolpack:Tsbc_System_Settings_3.1|Use this page as an example of Tabbed Headers]]
-[[Use this page as an example of Tabbed Headers|Toolpack:Tsbc_System_Settings_3.1]
+<headertabs/>