From LSWiki

Revision as of 23:33, 7 December 2007 (edit) Chaos (Talk | contribs) ← Previous diff		Current revision (14:44, 2 November 2011) (edit) Chaos (Talk | contribs) (→Formatting Suggestions - careful with the logs, yo)
Line 7:		Line 7:
	=Organizational Suggestions=		=Organizational Suggestions=
	* It's highly recommended that you use section headings within your article to provide a table of contents tree. Additionally this will allow you to use anchors within your document, which will greatly aid in further organizational suggestions		* It's highly recommended that you use section headings within your article to provide a table of contents tree. Additionally this will allow you to use anchors within your document, which will greatly aid in further organizational suggestions
-	* Avoid simply linking pages by their helpfile word content. This has become a bad habit, and causes some horribly ambiguity within powers, concepts, commands, skills, and other entities which may share a single name. A good example of this occuring would be the word "[[elf]]" or "[[invoke]]". Rather than these articles, you'd want to create a page for ELF Invocation, Reaper Invoke, then a disambig template page such as the one found at [[invoke]].	+	* Avoid simply linking pages by their helpfile word content. This has become a bad habit, and causes some horribly ambiguity within powers, concepts, commands, skills, and other entities which may share a single name. A good example of this occuring would be the word "[[elf]]" or "[[invoke]]". Rather than these articles, you'd want to create a page for ELF Invocation, Reaper Invoke, then a disambiguation page such as the one found at [[invoke]].
	* Try to group content into good complete articles. There's no reason for a guild with 40 helpfiles for various topics to have 40 articles -- instead, simply create a single article, and organize all your content into relevant section structures. A good example of this is the [[Red Magi Guild Home]] article.		* Try to group content into good complete articles. There's no reason for a guild with 40 helpfiles for various topics to have 40 articles -- instead, simply create a single article, and organize all your content into relevant section structures. A good example of this is the [[Red Magi Guild Home]] article.
	=Formatting Suggestions=		=Formatting Suggestions=
	* For the most part, text content from the game is formatted pretty well. Unfortunately this format won't directly translate to the wiki without some minor touch up work. The most simple example I can give of this would be used fairly extensively throughout all the pages you find. When pasting text from the game into an article, simply add a space character before every line. This will do a simple monospaced quoting style which will preserve the formatting well and still allow for wiki linking inline with the text.		* For the most part, text content from the game is formatted pretty well. Unfortunately this format won't directly translate to the wiki without some minor touch up work. The most simple example I can give of this would be used fairly extensively throughout all the pages you find. When pasting text from the game into an article, simply add a space character before every line. This will do a simple monospaced quoting style which will preserve the formatting well and still allow for wiki linking inline with the text.
		+	* Be careful with pasting sizable text logs into the wiki. They should generally, at minimum, be reformatted to have four spaces in front of each line before being put in. We have had an incident where the diff generation (computation of what changed between versions) for logs that needed extensive reformatting got completely out of control, locking up Web server processes and, once enough memory had been consumed, bringing the rest of the server (including the MUD) more or less screeching to a halt. We would like to not repeat that.
	=Spoiler Warnings=		=Spoiler Warnings=
	* Information that is likely to constitute spoilers should be marked using the spoiler boundary templates. These are used simply by putting <nowiki>{{spoilers}}</nowiki> and <nowiki>{{endspoilers}}</nowiki> in your page. See [[Free Imptropolis]] for an example. What's a spoiler and what isn't is a matter of judgment, but there are some things that are clearly always spoilers, like quest walkthroughs. For other things, the guideline is that if it's interesting information that takes some effort to find out through the game and is rewarding to discover, it's probably a spoiler.		* Information that is likely to constitute spoilers should be marked using the spoiler boundary templates. These are used simply by putting <nowiki>{{spoilers}}</nowiki> and <nowiki>{{endspoilers}}</nowiki> in your page. See [[Free Imptropolis]] for an example. What's a spoiler and what isn't is a matter of judgment, but there are some things that are clearly always spoilers, like quest walkthroughs. For other things, the guideline is that if it's interesting information that takes some effort to find out through the game and is rewarding to discover, it's probably a spoiler.
		+
		+	=Wiki Markup Guide=
		+	* Go [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page here] to learn the wiki markup language.
		+
		+	[[Category:Wiki Help]]

---

Current revision

Contents 1 General Submission Suggestions 2 Organizational Suggestions 3 Formatting Suggestions 4 Spoiler Warnings 5 Wiki Markup Guide

General Submission Suggestions

• Don't be afraid to edit a page and add content that you are able to contribute, even if you're unsure as to how to format it. Feel free to tag it and indicate that the contribution could use formatting cleanup after you provide the information -- there are plenty of people willing to assist with formatting information they may not be able to provide.

Organizational Suggestions

• It's highly recommended that you use section headings within your article to provide a table of contents tree. Additionally this will allow you to use anchors within your document, which will greatly aid in further organizational suggestions
• Avoid simply linking pages by their helpfile word content. This has become a bad habit, and causes some horribly ambiguity within powers, concepts, commands, skills, and other entities which may share a single name. A good example of this occuring would be the word "elf" or "invoke". Rather than these articles, you'd want to create a page for ELF Invocation, Reaper Invoke, then a disambiguation page such as the one found at invoke.
• Try to group content into good complete articles. There's no reason for a guild with 40 helpfiles for various topics to have 40 articles -- instead, simply create a single article, and organize all your content into relevant section structures. A good example of this is the Red Magi Guild Home article.

Formatting Suggestions

• For the most part, text content from the game is formatted pretty well. Unfortunately this format won't directly translate to the wiki without some minor touch up work. The most simple example I can give of this would be used fairly extensively throughout all the pages you find. When pasting text from the game into an article, simply add a space character before every line. This will do a simple monospaced quoting style which will preserve the formatting well and still allow for wiki linking inline with the text.
• Be careful with pasting sizable text logs into the wiki. They should generally, at minimum, be reformatted to have four spaces in front of each line before being put in. We have had an incident where the diff generation (computation of what changed between versions) for logs that needed extensive reformatting got completely out of control, locking up Web server processes and, once enough memory had been consumed, bringing the rest of the server (including the MUD) more or less screeching to a halt. We would like to not repeat that.

Spoiler Warnings

• Information that is likely to constitute spoilers should be marked using the spoiler boundary templates. These are used simply by putting {{spoilers}} and {{endspoilers}} in your page. See Free Imptropolis for an example. What's a spoiler and what isn't is a matter of judgment, but there are some things that are clearly always spoilers, like quest walkthroughs. For other things, the guideline is that if it's interesting information that takes some effort to find out through the game and is rewarding to discover, it's probably a spoiler.

Wiki Markup Guide

• Go here to learn the wiki markup language.