Wiki Editing Guidelines: Difference between revisions
(Create "Editing Guidelines" page -ZM) |
(Minor formatting corrections -ZM) |
||
| Line 3: | Line 3: | ||
== Readability == | == Readability == | ||
I have a strong preference for 'traditional' written English format. That means that every paragraph starts out with THREE spaces, and every sentence is separated from the one before it by TWO spaces. You know, like this short article. And every newspaper, magazine, and book you've ever read. If you only use ONE space between words, it is easy to tell when one sentence ends and another begins, even if the punctuation gets screwed up during an edit. <br> | I have a strong preference for 'traditional' written English format. That means that every paragraph starts out with THREE spaces, and every sentence is separated from the one before it by TWO spaces. You know, like this short article. And every newspaper, magazine, and book you've ever read. If you only use ONE space between words, it is easy to tell when one sentence ends and another begins, even if the punctuation gets screwed up during an edit. <br> | ||
This is a 'standard' because it makes reading easier. Less effort trying to pick out the paragraphs and sentences means more brainpower available to try to absorb the content instead of trying to FIND the content. <br> | This is a 'standard' because it makes reading easier. Less effort trying to pick out the paragraphs and sentences means more brainpower available to try to absorb the content instead of trying to FIND the content. The end result is that you don't get a headache after a while like you do trying to read minimal HTML. <br> | ||
Note that this is significantly different from "minimal HTML" which was created back in the late 1970s when both storage and bandwidth were limited. Because of this, minimal HTML deletes all line-leading 'white-space' and compresses all white-space anywhere else into one space. <br> | Note that this is significantly different from "minimal HTML" which was created back in the late 1970s when both storage and bandwidth were limited. Because of this, minimal HTML deletes all line-leading 'white-space' and compresses all white-space anywhere else into one space. <br> | ||
Many websites (SOL and standard wikis in particular) still enforce this. Thus, if you want that space to make it easier to read, you have to tell the software that you want it left alone. The standard way to do this in HTML is to use a code that this wiki version insists on converting into a space, so I can't show it here except by spacing out each character: | Many websites (SOL and standard wikis in particular) still enforce this. Thus, if you want that space to make it easier to read, you have to tell the software that you want it left alone. The standard way to do this in HTML is to use a code that this wiki version insists on converting into a space, so I can't show it here except by spacing out each character: | ||
| Line 13: | Line 13: | ||
Most articles will have some sort of preface before you get to the desired content. You know, like the warning in bold at the top of this one. <br> | Most articles will have some sort of preface before you get to the desired content. You know, like the warning in bold at the top of this one. <br> | ||
Wiki software supports an 'outline' structure, and when people are going to a wiki to find things, it helps if things are always organized the same way. If you are creating a new page for a new infantry weapon, look at the pages that already exist for other weapons and organize yours like them. <br> | Wiki software supports an 'outline' structure, and when people are going to a wiki to find things, it helps if things are always organized the same way. If you are creating a new page for a new infantry weapon, look at the pages that already exist for other weapons and organize yours like them. <br> | ||
We collect all the (unseen) 'category' declarations at the bottom, and then put the 'navigation' template call | We collect all the (unseen) 'category' declarations at the very bottom of the page, and then put the 'navigation' template call right above them, since that's where we want to see it anyway. If you click on the 'edit' button at the top of this page you'll see all the codes that make this happen. <br> | ||
[[Category:Wiki Maintenance]] | [[Category:Wiki Maintenance]] | ||
Revision as of 08:02, 22 April 2024
(This page is currently just ZM's opinions, none of them hold any sort of authority. That comes from the consensus of the collective Swarm Cycle authors, generated on the email list, with TH as always holding a veto. Until I get further guidance, this is how _I'm_ doing it. ZM User (talk) 08:46, 22 April 2024 (PDT))
Readability
I have a strong preference for 'traditional' written English format. That means that every paragraph starts out with THREE spaces, and every sentence is separated from the one before it by TWO spaces. You know, like this short article. And every newspaper, magazine, and book you've ever read. If you only use ONE space between words, it is easy to tell when one sentence ends and another begins, even if the punctuation gets screwed up during an edit.
This is a 'standard' because it makes reading easier. Less effort trying to pick out the paragraphs and sentences means more brainpower available to try to absorb the content instead of trying to FIND the content. The end result is that you don't get a headache after a while like you do trying to read minimal HTML.
Note that this is significantly different from "minimal HTML" which was created back in the late 1970s when both storage and bandwidth were limited. Because of this, minimal HTML deletes all line-leading 'white-space' and compresses all white-space anywhere else into one space.
Many websites (SOL and standard wikis in particular) still enforce this. Thus, if you want that space to make it easier to read, you have to tell the software that you want it left alone. The standard way to do this in HTML is to use a code that this wiki version insists on converting into a space, so I can't show it here except by spacing out each character:
& n b s p ;
To people who grew up in the dark ages, that translates to "start special code, Non-Breaking SPace, end code". I just type the characters once, then <CTRL>-C and I paste it in whenever I need it while typing. After a while it becomes just part of your typing, like capitalizing the first word of every sentence, and it makes your text a LOT easier to read.
Okay, end of sermon. I can't make everyone else do it, but I'm certainly going to.
Article Sections
Most articles will have some sort of preface before you get to the desired content. You know, like the warning in bold at the top of this one.
Wiki software supports an 'outline' structure, and when people are going to a wiki to find things, it helps if things are always organized the same way. If you are creating a new page for a new infantry weapon, look at the pages that already exist for other weapons and organize yours like them.
We collect all the (unseen) 'category' declarations at the very bottom of the page, and then put the 'navigation' template call right above them, since that's where we want to see it anyway. If you click on the 'edit' button at the top of this page you'll see all the codes that make this happen.
(Someday this will be a navigation template. It will provide a bar across the bottom of each article with useful navigation links. Until then, this is just a placeholder to get rid of all the red "broken link" indicators. -ZM User (talk) 10:00, 3 May 2024 (PDT))
