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

← Older revision		Revision as of 15:22, 17 December 2012
Line 40:		Line 40:

	* Shows the proper way to set the fields in 1 form		* 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		** Links to relevant Parameter page

Cbilodeau: add examples and update parameter page section

2012-12-17T19:15:18Z

add examples and update parameter page section

← Older revision		Revision as of 15:15, 17 December 2012
Line 51:		Line 51:
	* Describes the possible values and their behaviors (tooltips by default)		* Describes the possible values and their behaviors (tooltips by default)
	* Part of the 'Parameters' category		* Part of the 'Parameters' category
			<nowiki>[[Category:Parameters]]</nowiki>
	* Link back to step pages		* Link back to step pages
	** 1 link per major		** 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)		* 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		** Timer pages contain a table of all the timers and their definition
Line 59:		Line 60:
	Examples:		Examples:
	*[[Parameter:_Channel_Usage\|Channel Usage]]		*[[Parameter:_Channel_Usage\|Channel Usage]]
			*[[Parameter:_Isup_Userpart_Timers\|ISUP Userpart Timers]]

	= Web portal tutorial convention =		= Web portal tutorial convention =

Cbilodeau: Reformat web portal tutorial architecture section + add examples

2012-12-17T18:56:50Z

Reformat web portal tutorial architecture section + add examples

← Older revision		Revision as of 14:56, 17 December 2012
Line 10:		Line 10:
	*Quickly know which version a page applies		*Quickly know which version a page applies

			= Web portal tutorial guide architecture =

	The web portal tutorial guide is split in 3 levels:		The web portal tutorial guide is split in 3 levels:
	* Major version main page		* Major version main page
	* Step pages		* Step pages
	* Parameters ~~page~~		** Step pages for advanced features
			* Parameters pages

	=== Major version main page ===		== Major version main page ==

	* Feature configuration oriented		* Feature configuration oriented
Line 24:		Line 26:
	* Links to the corporate web site		* Links to the corporate web site

	=== Step ~~page =~~==		== Step pages ==

	* Shows the proper way to set the fields in 1 form		* Shows the proper way to set the fields in 1 form
Line 32:		Line 34:

	Examples:		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		* Shows the proper way to set the fields in 1 form
Line 41:		Line 43:
	** Links to relevant Parameter page		** Links to relevant Parameter page

			Examples:
			*[[Toolpack:Modifying_Profile_for_SPIROU_A\|Modifying Profile for SPIROU]]

	=== Parameter ~~page =~~==		== Parameter pages ==

	* Name always starts with 'Parameter:'		* Name always starts with 'Parameter:'
Line 53:		Line 57:
	** Timer pages contain a table of all the timers and their definition		** Timer pages contain a table of all the timers and their definition

			Examples:
			*[[Parameter:_Channel_Usage\|Channel Usage]]

	== Web portal tutorial convention ==		= Web portal tutorial convention =

	The following are mandatory when describing web procedures.		The following are mandatory when describing web procedures.

	=== Page URL ===		== Page URL ==

	* Toolpack version number are no longer in the title		* Toolpack version number are no longer in the title
Line 70:		Line 76:
	Toolpack:Creating_a_New_Gateway_Configuration_B		Toolpack:Creating_a_New_Gateway_Configuration_B

	=== Page title ===		== Page title ==
	* Set display title (Note: that the version is not present)		* Set display title (Note: that the version is not present)
	Example for page 'Toolpack:Creating_an_IP_Port_Range_A'		Example for page 'Toolpack:Creating_an_IP_Port_Range_A'
	<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>		<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>

	=== Page content ===		== Page content ==

	* '''First''' sentence contains Toolpack version		* '''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)		*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		*Buttons are clicked

Cbilodeau at 22:05, 14 December 2012

2012-12-14T22:05:45Z

@@ 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 ==

Cbilodeau: re-arrange convention section

2012-08-06T16:20:46Z

re-arrange convention section

← Older revision		Revision as of 12:20, 6 August 2012
Line 14:		Line 14:
	The following are mandatory when describing web procedures.		The following are mandatory when describing web procedures.

	=== Page ~~title~~ ===		=== Page URL ===

	* Toolpack version number are no longer in the title		* Toolpack version number are no longer in the title
Line 25:		Line 25:
	Second version		Second version
	Toolpack:Creating_a_New_Gateway_Configuration_B		Toolpack:Creating_a_New_Gateway_Configuration_B

			=== 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 ===
Line 33:		Line 38:
	<nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki>		<nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki>

	* 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>~~

	=== Tips ===		=== 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]]		[[Web_Portal_Tutorial_Guide_v2.5#Configuring_SS7\|Example:Configuring the ISUP Layer]]
	*Title should starts with a verb that represent an action.		*Title should starts with a verb that represent an action.

Cbilodeau: add Allyn tips and terminology

2012-07-30T20:31:34Z

add Allyn tips and terminology

@@ Line 1: / Line 1: @@
 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.
@@ Line 37: / Line 39: @@
 === Tips ===
-*Split your procedures into several steps (1 form per page)
+*Establish the tasks sequence and 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]]
-*Add screen shots with red circles or squares
+*Title should starts with a verb that represent an action.
-[[Toolpack:Creating_SS7_Point_Codes_A|Example: Creating SS7 Point Codes]]
+Example: Adding an Adapter, Edit the SCTP Configuration
 [[Category:Help]]

Cbilodeau: /* Page content */ fix example

2012-07-25T18:12:25Z

Page content: fix example

← Older revision		Revision as of 14:12, 25 July 2012
Line 27:		Line 27:

	* '''First''' sentence contains Toolpack version		* '''First''' sentence contains Toolpack version
	~~===~~ '''''Applies to version(s): v2.5, v2.6.''''' ~~===~~		'''''Applies to version(s): v2.5, v2.6.'''''
	Wiki code for page that is the same for v2.5 and v2.6		Wiki code for page that is the same for v2.5 and v2.6
	<nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki>		<nowiki>=== '''''Applies to version(s): v2.5, v2.6.''''' ===</nowiki>

Cbilodeau: reformat tips

2012-07-25T18:11:49Z

reformat tips

← Older revision		Revision as of 14:11, 25 July 2012
Line 28:		Line 28:
	* '''First''' sentence contains Toolpack version		* '''First''' sentence contains Toolpack version
	=== '''''Applies to version(s): v2.5, v2.6.''''' ===		=== '''''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>		<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)
			Example for page 'Toolpack:Creating_an_IP_Port_Range_A'
	<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>		<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki>

	=== Tips ===		=== 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]]
			*Add screen shots with red circles or squares
			[[Toolpack:Creating_SS7_Point_Codes_A\|Example: Creating SS7 Point Codes]]

	[[Category:Help]]		[[Category:Help]]

Cbilodeau: Add tips

2012-07-24T20:48:28Z

Add tips

← Older revision		Revision as of 16:48, 24 July 2012
Line 9:		Line 9:

	== Web portal tutorial convention ==		== Web portal tutorial convention ==

			The following are mandatory when describing web procedures.

	=== Page title ===		=== Page title ===

	* Toolpack version number are no longer in the title		* Toolpack version number are no longer in the title
	~~Old title~~		Example
	~~Toolpack_v2.5:Creating_a_New_Gateway_Configuration~~
	~~New title~~
	Toolpack:Creating_a_New_Gateway_Configuration_A		Toolpack:Creating_a_New_Gateway_Configuration_A

Line 26:		Line 26:
	=== Page content ===		=== Page content ===

	* First sentence contains Toolpack version		* '''First''' sentence contains Toolpack version
	=== '''''Applies to version(s): v2.5, v2.6.''''' ===		=== '''''Applies to version(s): v2.5, v2.6.''''' ===
	Wiki code		Wiki code
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>

			=== Tips ===

			*Split your procedures into several steps [[Web_Portal_Tutorial_Guide_v2.5#Configuring_SS7\|Example:Configuring the ISUP Layer]]
			*Add screen shots with red circles or squares [[Toolpack:Creating_SS7_Point_Codes_A\|Example: Creating SS7 Point Codes]]

	[[Category:Help]]		[[Category:Help]]

Cbilodeau: add category

2012-07-23T13:55:39Z

add category

← Older revision		Revision as of 09: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]]