Wiki Best Practices - Revision history

Jrwrigh: Fix up subpages topic

2022-09-18T17:39:49Z

Fix up subpages topic

Jrwrigh: Add subpages topic

2022-09-18T17:37:26Z

Add subpages topic

Jrwrigh: /* Format Your Wiki Page */

2020-09-03T15:31:48Z

‎Format Your Wiki Page

Jrwrigh: /* Avoid Orphaned Articles */

2020-09-03T15:31:15Z

‎Avoid Orphaned Articles

Jrwrigh: Added note about subcategories.

2020-08-25T04:44:22Z

Added note about subcategories.

Jrwrigh: Add link to formatting page in

2020-08-24T22:48:45Z

Add link to formatting page in

Jrwrigh: Created page with "Here are a few hints/rules for adding pages to the Wiki. Following these guidelines will help to make this wiki an effective (and useful) documentation tool and assist others..."

2020-08-24T22:41:38Z

Created page with "Here are a few hints/rules for adding pages to the Wiki. Following these guidelines will help to make this wiki an effective (and useful) documentation tool and assist others..."

New page

Here are a few hints/rules for adding pages to the Wiki. Following these guidelines will help to make this wiki an effective (and useful) documentation tool and assist others in helping to find the right information. They are sorted below in order of importance.

==Avoid Orphaned Articles==
Your article won't go anywhere if it isn't linked elsewhere in the site. Add links to the article using the double square bracket syntax or hyperlinks when the article title is used in other parts of the wiki.

==Put Articles in Appropriate Categories==
Categories help to group useful information together. Their syntax is <code><nowiki>[[Category:{NAME_OF_CATEGORY}]]</nowiki></code>.

[[:Special:Categories|List of Categories]]. If you don't find a category that's applicable, see about

==Format Your Wiki Page==
This can '''seriously''' help the usability of a wiki page. It makes it more readable and makes finding specific information significantly faster. Do things like:

*Use headings and subheadings (it'll auto-populate the outline at the very top of the article)
*Use bullet and number lists (they can be hierarchical as well)
*Make text in a "code" format using code HTML flags: <code><nowiki><code>print('Hello World')</code></nowiki></code> creates <code>print('Hello World')</code>

==Continue to Make Improvements==
Wikis are community built; therefore, not all the work should be done yourself. After writing the initial article, upload and seek feedback on it. Other users can discuss potential changes in the Discussion panel of any article and implement when a consensus is reached.

@@ Line 5: / Line 5: @@
 ==Use subpages for hierarchical organization==
-If you are talking about a specific aspect of a larger topic, then [[subpages https://www.mediawiki.org/wiki/Help:Subpages]] are a good idea. These allow for individual pages about a common topic to be organized together naturally.
+If you are talking about a specific aspect of a larger topic, then [https://www.mediawiki.org/wiki/Help:Subpages subpages] are a good idea. These allow for individual pages about a common topic to be organized together naturally. For example, if talking about a specific PHASTA feature, you could make a subpage for that feature.
-For example, if talking about a specific PHASTA feature, you could make a subpage for that feature.
+Subpages are created with a slash between the subpage and it's parent. So creating a page at <code>https://fluid.colorado.edu/wiki/index.php/PHASTA/New-Feature</code> would create a subpage.
-This can allow for '''automatic backlinking''', keeping everything pretty organized. This is done by adding a:
+Using subpages allows for '''automatic backlinking''', keeping everything pretty organized. This is done by adding a:
   == Subpages ==

@@ Line 2: / Line 2: @@
 ==Avoid Orphaned Articles==
-Your article won't go anywhere if it isn't linked elsewhere in the site. Add links to the article using the double square bracket syntax or hyperlinks when the article title is used in other parts of the wiki. You want to know how people can do down a rabbit hole on Wikipedia? It's because all the articles are linked to each other.
+Your article won't go anywhere if it isn't linked elsewhere in the site. Add links to the article using the [https://www.mediawiki.org/wiki/Cheatsheet double square bracket syntax or hyperlinks] when the article title is used in other parts of the wiki. You want to know how people can do down a rabbit hole on Wikipedia? It's because all the articles are linked to each other.
 ==Put Articles in Appropriate Categories==

← Older revision		Revision as of 04:44, 25 August 2020
Line 8:		Line 8:

	[[:Special:Categories\|List of Categories]]. If you don't find a category that's applicable, add a new one (though maybe ask around to get opinions).		[[:Special:Categories\|List of Categories]]. If you don't find a category that's applicable, add a new one (though maybe ask around to get opinions).
		+
		+	Note that there are subcategories. As a rule of thumb, an wiki article should be placed in as specific a category as possible.

	==Format Your Wiki Page==		==Format Your Wiki Page==

@@ Line 14: / Line 14: @@
 This can '''seriously''' help the usability of a wiki page. It makes it more readable and makes finding specific information significantly faster. Do things like:
-*Use headings and subheadings (it'll auto-populate the outline at the very top of the article)
+*Use headings and subheadings (it'll auto-populate the "Contents" outline at the very top of the article)
 *Use bullet and number lists (they can be hierarchical as well)
 *Make text in a "code" format using code HTML flags: <code><nowiki><code>print('Hello World')</code></nowiki></code> creates <code>print('Hello World')</code>