TBwiki:Getting started - Revision history

Cbilodeau: redirect page to help content

2012-07-20T19:19:16Z

redirect page to help content

Show changes

Ktrueman: /* Policies and procedures */

2009-08-25T13:51:28Z

Policies and procedures

Ktrueman: /* Article content */ added info on editing FAQs

2009-08-21T21:04:39Z

Article content: added info on editing FAQs

Ktrueman: /* Article content */

2009-08-19T20:50:51Z

Article content

Ktrueman: /* Ensuring content remains current */ added link to new category type

2009-08-07T15:52:39Z

Ensuring content remains current: added link to new category type

Ktrueman: fixed link to signaling

2009-08-07T15:49:09Z

fixed link to signaling

Ktrueman: /* New page content */

2009-07-24T19:26:02Z

New page content

Ktrueman: consolidated content and clarified some steps

2009-07-24T19:24:41Z

consolidated content and clarified some steps

Show changes

Ktrueman: /* Editing */

2009-07-24T18:47:34Z

Editing

Ktrueman: moved content from the standards page

2009-07-24T18:41:25Z

moved content from the standards page

← Older revision		Revision as of 13:51, 25 August 2009
Line 68:		Line 68:

	As a result, it is the responsibility of all users to ensure the quality of the content that they view on--and contribute to--this site. We therefore propose some steps that should ensure that this is what happens.		As a result, it is the responsibility of all users to ensure the quality of the content that they view on--and contribute to--this site. We therefore propose some steps that should ensure that this is what happens.
		+
		+	=== Conventions ===
		+	*All acronyms should be capitalized (e.g, DHCP and not dhcp; IP not ip, etc.)
		+	*Where an acronym is used for the first time in an article that defines what the acronym stands for, you should spell out the acronym. For example, an article on DHCP should start as follows, with later references retaining the acronym: "Dynamic Host Configuration Protocol (DHCP) is a ... . DHCP also provides... "

	=== Monitoring a page ===		=== Monitoring a page ===

@@ Line 51: / Line 51: @@
 *Additional information indicating the category of the topic. For technical standards, etc., this is always 'Glossary'.
-Note: See the [[SS7|article on SS7 signaling]] for a good example of the desired approach. Click on the 'Edit tab' to see how the formatting codes are applied to generate the page formatting.
 === Duplicate content ===

@@ Line 47: / Line 47: @@
 *General discussion/description
 *Discussion about how TelcoBridges supports the topic in question; the section header title should be 'TelcoBridges and 'topic name''
-*Links to related actions that can be achieved with the topic under discussion. For example, the ability to configure hardware or software to use a given function. The section header title should be 'Related actions'
+*Links to '''related actions''' that can be achieved with the topic under discussion. For example, the ability to configure hardware or software to use a given function. The section header title should be 'Related actions'
-*Links to related articles from sites such as Wikipedia or organizations such as the ITU and the IETF, among many others; the section header title should be 'References'.
+*Links to '''related articles''' from sites such as Wikipedia or organizations such as the ITU and the IETF, among many others; the section header title should be 'References'.
 *Additional information indicating the category of the topic. For technical standards, etc., this is always 'Glossary'.
@@ Line 55: / Line 55: @@
 === Duplicate content ===
 If you are bringing in new content to TBwiki and there is topic-specific content that exists already, please refer to that topic whenever possible. If applicable, and it can be done so while leaving the topic concise in nature, update the topic itself with the new information, instead of leaving it at the new article level. Then refer to the updated topic from your new level.
 == Policies and procedures ==

← Older revision		Revision as of 15:52, 7 August 2009
Line 82:		Line 82:
	# From time to time, you should click on the link titled "[http://docs.telcobridges.com/mediawiki/index.php/Special:Specialpages Special pages]" found in the 'Toolbox' navigation bar on the left-hand side of each page. From there, you will find a link titled '[http://docs.telcobridges.com/mediawiki/index.php/Special:Wantedpages Wanted pages]'. Clicking that link will provide you with a list of proposed pages-- created by links -- for which no content has been provided. By adding content to those pages, you are helping to improve this site.		# From time to time, you should click on the link titled "[http://docs.telcobridges.com/mediawiki/index.php/Special:Specialpages Special pages]" found in the 'Toolbox' navigation bar on the left-hand side of each page. From there, you will find a link titled '[http://docs.telcobridges.com/mediawiki/index.php/Special:Wantedpages Wanted pages]'. Clicking that link will provide you with a list of proposed pages-- created by links -- for which no content has been provided. By adding content to those pages, you are helping to improve this site.

		+
		+	If you come across a page that appears to be out of date and that would benefit from being updated, please add the following to the bottom of the page:
		+	<pre>[[category:Needs revising]]</pre>
		+
		+	This will automatically populate a page with links to article that need to be revised. On a regular basis, we will consult the list of pages that need to be revised. This is in addition to the usual page revision efforts.

	== References ==		== References ==

@@ Line 24: / Line 24: @@
 '''Other considerations'''
 *Please focus on being as concise as possible.
-*To facilitate legibility, consider adding a double space between each element in the page, such as a section header, an inserted image, or even a paragraph. (This last one is up to you; if you think it improves readibility, add that extra line space.)
+*To facilitate legibility, consider adding a double space between each element in the page, such as a section header, an inserted image, or even a paragraph. (This last one is up to you; if you think it improves readability, add that extra line space.)
 *Images that are not core to the article at hand (i.e., they are facultative) should be represented with a thumbnail and a short description
 *Sub-sections should be clearly identified as such (wrapping the header with two 'equal signs' before and after the header to apply the formatting)
@@ Line 44: / Line 44: @@
-For '''industry topics''' such as [[RFC|RFCs]], [[Signaling|signaling]] stacks or protocols, [[Voice codecs|voice codecs]], and other technical standards, please take the following approach:
+For '''industry topics''' such as [[RFC|RFCs]], [[signaling protocols]], [[voice codecs]], and other technical standards, please take the following approach:
 *General discussion/description
 *Discussion about how TelcoBridges supports the topic in question; the section header title should be 'TelcoBridges and 'topic name''

← Older revision		Revision as of 19:26, 24 July 2009
Line 29:		Line 29:
	*Sub-sub-sections should be identified as well. (These require three equal signs before and after the header text)		*Sub-sub-sections should be identified as well. (These require three equal signs before and after the header text)

		+
		+	'''Important note:''' There is a list of [http://docs.telcobridges.com/mediawiki/index.php/Special:Wantedpages wanted pages], which refers to pages requiring content, as well as a page for [[Suggested articles\|suggesting new articles]].

	== Article content ==		== Article content ==

@@ Line 4: / Line 4: @@
-== Editing ==
+Wikipedia provides an overview of [http://en.wikipedia.org/wiki/How_to_edit how to edit a page] in a Wiki based on the [http://www.mediawiki.org MediaWiki] authoring platform. You may find it worthwhile to follow this [http://en.wikipedia.org/wiki/Wikipedia:Tutorial tutorial] as well.
-This [http://en.wikipedia.org/wiki/How_to_edit page] provides an overview of how to edit pages in a Wiki based on MediaWiki. You may find it worthwhile to follow this [http://en.wikipedia.org/wiki/Wikipedia:Tutorial tutorial] as well.
 To supplement the basic page editing tools provided with MediaWiki, you should consider enabling a 3rd-party solution called [http://en.wikipedia.org/wiki/User:Cacycle/wikEd#Installation wikED]. This requires using the [http://www.mozilla.com/en-US/firefox/ Firefox] web browser and having the [https://addons.mozilla.org/en-US/firefox/addon/748 Greasemonkey] extension installed.
 Please note that in order to make (lasting) changes to this site, you must be a registered user.
 == Page content ==

← Older revision		Revision as of 18:41, 24 July 2009
Line 56:		Line 56:
	# From time to time, you should click on the link titled "[http://docs.telcobridges.com/mediawiki/index.php/Special:Specialpages Special pages]" found in the 'Toolbox' navigation bar on the left-hand side of each page. From there, you will find a link titled '[http://docs.telcobridges.com/mediawiki/index.php/Special:Lonelypages Orphaned pages]'. Clicking that link will provide you with a list of those pages that have not been revised for the longest period of time.		# From time to time, you should click on the link titled "[http://docs.telcobridges.com/mediawiki/index.php/Special:Specialpages Special pages]" found in the 'Toolbox' navigation bar on the left-hand side of each page. From there, you will find a link titled '[http://docs.telcobridges.com/mediawiki/index.php/Special:Lonelypages Orphaned pages]'. Clicking that link will provide you with a list of those pages that have not been revised for the longest period of time.
	# From time to time, you should click on the link titled "[http://docs.telcobridges.com/mediawiki/index.php/Special:Specialpages Special pages]" found in the 'Toolbox' navigation bar on the left-hand side of each page. From there, you will find a link titled '[http://docs.telcobridges.com/mediawiki/index.php/Special:Wantedpages Wanted pages]'. Clicking that link will provide you with a list of proposed pages-- created by links -- for which no content has been provided. By adding content to those pages, you are helping to improve this site.		# From time to time, you should click on the link titled "[http://docs.telcobridges.com/mediawiki/index.php/Special:Specialpages Special pages]" found in the 'Toolbox' navigation bar on the left-hand side of each page. From there, you will find a link titled '[http://docs.telcobridges.com/mediawiki/index.php/Special:Wantedpages Wanted pages]'. Clicking that link will provide you with a list of proposed pages-- created by links -- for which no content has been provided. By adding content to those pages, you are helping to improve this site.
		+
		+
		+
		+
		+	== MORE CONTENT TO INTEGRATE ==
		+
		+	'''UNDER CONSTRUCTION'''
		+
		+	The following guidelines are designed to facilitate finding and consulting content on TBwiki.
		+
		+	== Page layout ==
		+	*To facilitate legibility, add a double space between each section
		+
		+
		+	== Images ==
		+	*Images that are not core to the article at hand (i.e., they are facultative) should be represented with a thumbnail and a short description
		+
		+
		+	== Required sections ==
		+	* At the end of each page, you should provide a link to reference documents, whether they are found on this wiki, the public TelcoBridges web site or other externally available TelcoBridges servers, when applicable. You should also provide a link to technical resources such as [http://www.wikipedia.org Wikipedia], [http://www.ietf.org IETF], [http://www.itu.int ITU] or other such sites when the information is available.
		+
		+
		+	==Optional Sections==
		+	*Where possible, include a section called '''Related Actions'''. This provides a link to instructions on how to make use of the feature in question and can help to resolve information requirements since there is some context to what the user is looking for.
		+
		+
		+	== References ==
		+
		+	[http://en.wikipedia.org/wiki/How_to_edit Wikipedia article on Editing]