Help:Web portal tutorial guidelines
From TBwiki
(Difference between revisions)
(creation) |
(Add web portal convention) |
||
| Line 1: | Line 1: | ||
| − | TelcoBridges support multiple | + | TelcoBridges support multiple versions simultaneously. We are therefore forced to maintain multiple procedures because of interface changes.This goes somewhat against the wiki philosophy where you always have the latest and the greatest. |
The following naming convention takes into consideration: | The following naming convention takes into consideration: | ||
| − | *Support multiple | + | *Support multiple versions of the same procedure |
*Avoid duplication of the same content | *Avoid duplication of the same content | ||
*Relevant page title | *Relevant page title | ||
*Quickly know which version a page applies | *Quickly know which version a page applies | ||
| − | == | + | == Web portal tutorial convention == |
| + | |||
| + | === Page title === | ||
| + | |||
| + | * Toolpack version number are no longer in the title | ||
| + | Old title | ||
| + | Toolpack_v2.5:Creating_a_New_Gateway_Configuration | ||
| + | New title | ||
| + | Toolpack:Creating_a_New_Gateway_Configuration_A | ||
| + | |||
| + | * Versions of the same page are identify with letters | ||
| + | First version of the procedure | ||
| + | Toolpack:Creating_a_New_Gateway_Configuration_A | ||
| + | Second version | ||
| + | Toolpack:Creating_a_New_Gateway_Configuration_B | ||
| + | |||
| + | === Page content === | ||
| + | |||
| + | * First sentence contains Toolpack version | ||
| + | === '''''Applies to version(s): v2.5, v2.6.''''' === | ||
| + | Wiki code | ||
| + | <nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki> | ||
| + | |||
| + | * Set display title (Note that the version is not present) | ||
| + | <nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki> | ||
Revision as of 08:44, 23 July 2012
TelcoBridges support multiple versions simultaneously. We are therefore forced to maintain multiple procedures because of interface changes.This goes somewhat against the wiki philosophy where you always have the latest and the greatest.
The following naming convention takes into consideration:
- Support multiple versions of the same procedure
- Avoid duplication of the same content
- Relevant page title
- Quickly know which version a page applies
Web portal tutorial convention
Page title
- Toolpack version number are no longer in the title
Old title
Toolpack_v2.5:Creating_a_New_Gateway_Configuration
New title
Toolpack:Creating_a_New_Gateway_Configuration_A
- Versions of the same page are identify with letters
First version of the procedure
Toolpack:Creating_a_New_Gateway_Configuration_A
Second version
Toolpack:Creating_a_New_Gateway_Configuration_B
Page content
- First sentence contains Toolpack version
=== Applies to version(s): v2.5, v2.6. ===
Wiki code
=== '''''Applies to version(s): v2.5, v2.6.''''' ===
- Set display title (Note that the version is not present)
{{DISPLAYTITLE:Creating an IP Port Range}}
