Help:Web portal tutorial guidelines - Revision history

Cbilodeau: add precision in step pages for advanced features

2012-12-17T19:22:51Z

add precision in step pages for advanced features

Cbilodeau: add examples and update parameter page section

2012-12-17T19:15:18Z

add examples and update parameter page section

Cbilodeau: Reformat web portal tutorial architecture section + add examples

2012-12-17T18:56:50Z

Reformat web portal tutorial architecture section + add examples

Cbilodeau at 22:05, 14 December 2012

2012-12-14T22:05:45Z

Cbilodeau: re-arrange convention section

2012-08-06T16:20:46Z

re-arrange convention section

Cbilodeau: add Allyn tips and terminology

2012-07-30T20:31:34Z

add Allyn tips and terminology

Cbilodeau: /* Page content */ fix example

2012-07-25T18:12:25Z

Page content: fix example

Cbilodeau: reformat tips

2012-07-25T18:11:49Z

reformat tips

Cbilodeau: Add tips

2012-07-24T20:48:28Z

Add tips

Cbilodeau: add category

2012-07-23T13:55:39Z

add category

@@ Line 40: / Line 40: @@
 * Shows the proper way to set the fields in 1 form
-* 'List of Parameter' section (Only describes the ones modified)
+* 'List of Parameter' section (Only describes the ones modified from default values)
 ** Links to relevant Parameter page

@@ Line 51: / Line 51: @@
 * Describes the possible values and their behaviors (tooltips by default)
 * Part of the 'Parameters' category
 * Link back to step pages
 ** 1 link per major
-**
+** 1 link per relevant step page
 * For timers, 1 page per form (i.e. 1 parameter page for all MTP2 link timers, 1 parameter page for all MTP3 timers, 1 parameter page for all MTP3 link timers)
 ** Timer pages contain a table of all the timers and their definition
@@ Line 59: / Line 60: @@
 Examples:
 *[[Parameter:_Channel_Usage|Channel Usage]]
 = Web portal tutorial convention =

@@ Line 10: / Line 10: @@
 *Quickly know which version a page applies
 The web portal tutorial guide is split in 3 levels:
 * Major version main page
 * Step pages
-* Parameters page
+** Step pages for advanced features
-=== Major version main page ===
+== Major version main page ==
 * Feature configuration oriented
@@ Line 24: / Line 26: @@
 * Links to the corporate web site
-=== Step page ===
+== Step pages ==
 * Shows the proper way to set the fields in 1 form
@@ Line 32: / Line 34: @@
 Examples:
-*[[Toolpack:Creating_an_ISUP_Stack_A|Creating_an_ISUP_Stack_A]]
+*[[Toolpack:Creating_an_ISUP_Stack_A|Creating an ISUP Stack]]
-*[[]]
+*[[Toolpack:Creating_a_NAP_(ISUP)_A|Creating a NAP (ISUP)]]
-==== Step page for advanced feature ====
+=== Step pages for advanced feature ===
 * Shows the proper way to set the fields in 1 form
@@ Line 41: / Line 43: @@
 ** Links to relevant Parameter page
-=== Parameter page ===
+== Parameter pages ==
 * Name always starts with 'Parameter:'
@@ Line 53: / Line 57: @@
 ** Timer pages contain a table of all the timers and their definition
-== Web portal tutorial convention ==
+= Web portal tutorial convention =
 The following are mandatory when describing web procedures.
-=== Page URL ===
+== Page URL ==
 * Toolpack version number are no longer in the title
@@ Line 70: / Line 76: @@
   Toolpack:Creating_a_New_Gateway_Configuration_B
-=== Page title ===
+== Page title ==
 * Set display title (Note: that the version is not present)
 Example for page 'Toolpack:Creating_an_IP_Port_Range_A'
   <nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>
-=== Page content ===
+== Page content ==
 * '''First''' sentence contains Toolpack version
@@ Line 83: / Line 89: @@
-=== Tips ===
+== Tips ==
 *Establish the tasks sequence and link those to the main web portal guide page (1 form per page)
@@ Line 99: / Line 105: @@
-=== Terminology ===
+== Terminology ==
 *Buttons are clicked

@@ Line 1: / Line 1: @@
 __NOTOC__
-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.
+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:
@@ Line 9: / Line 9: @@
 *Relevant page title
 *Quickly know which version a page applies
 == Web portal tutorial convention ==

@@ Line 14: / Line 14: @@
 The following are mandatory when describing web procedures.
-=== Page title ===
+=== Page URL ===
 * Toolpack version number are no longer in the title
@@ Line 25: / Line 25: @@
 Second version
   Toolpack:Creating_a_New_Gateway_Configuration_B
 === Page content ===
@@ Line 33: / Line 38: @@
   <nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki>
 === Tips ===
-*Establish the tasks sequence and those to the main web portal guide page (1 form per page)
+*Establish the tasks sequence and link those to the main web portal guide page (1 form per page)
 [[Web_Portal_Tutorial_Guide_v2.5#Configuring_SS7|Example:Configuring the ISUP Layer]]
 *Title should starts with a verb that represent an action.

@@ Line 28: / Line 28: @@
 * '''First''' sentence contains Toolpack version
   === '''''Applies to version(s): v2.5, v2.6.''''' ===
-Wiki code
+Wiki code for page that is the same for v2.5 and v2.6
   <nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki>
-* Set display title (Note that the version is not present)
+* Set display title (Note: that the version is not present)
   <nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>
 === Tips ===
-*Split your procedures into several steps [[Web_Portal_Tutorial_Guide_v2.5#Configuring_SS7|Example:Configuring the ISUP Layer]]
+*Split your procedures into several steps (1 form per page)
-*Add screen shots with red circles or squares [[Toolpack:Creating_SS7_Point_Codes_A|Example: Creating SS7 Point Codes]]
+[[Web_Portal_Tutorial_Guide_v2.5#Configuring_SS7|Example:Configuring the ISUP Layer]]
 [[Category:Help]]

← Older revision		Revision as of 13:55, 23 July 2012
Line 33:		Line 33:
	* Set display title (Note that the version is not present)		* Set display title (Note that the version is not present)
	<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>		<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>
		+
		+	[[Category:Help]]