Wiki/Operation/AniNIX::Wiki:Manual_of_Styl...

5.1 KiB

This is intended to give contributors a baseline for editing.

Proper naming

Services on this network are properly titled in the below format. This should always be used the first time a service is referenced.

AniNIX::{ServiceName}[/{Area}][ \\ {Title}]

Grammar

Grammar is a writer's toolbox. You can't build good sentences without knowing how to use your tools. Since a wiki article should be as clear as possible for all those reading it, editors should keep their edits as grammatically correct as is possible, in order to ensure clear communication of the information being provided.[http://assassinscreed.wikia.com/wiki/Assassin's_Creed_Wiki:Manual_of_Style Assassin's Creed Wiki MoS]

Capitalization

Words should be capitalized at the start of each sentence, and when they are denoting a name or title, in line with current grammatical precedent, for example:

::"The Aether project should be used to back up critical servers."

Titles of works

Titles of works should be italicized to make clear that they are names; the titles of articles, chapters, and other short works should not be italicized, but are enclosed in double quotation marks.

Writing Style

:“I believe the road to hell is paved with adverbs” -- Stephen King

We now come to the meat of an article: the words themselves. When you're editing wikis, you're both academic and artist. You have to be accurate, but you also have to be interesting. Neither one can dominate; you have to skillfully balance both.

Keep your writing concise. Don't use two words where one will do. Keeping your writing simple will make it easy to understand and easy to expand on. Use complete sentences whenever possible. When you write, use grammar as a toolbox: know the rules, but only break them on purpose.

Check your spelling and grammar. Do not use 'u' in place of 'you' or '2' in place of 'to'. Write the way you would for a class paper or a newspaper article.

Keep all of the topics you cover within the scope of the article. What that means is, you don't need to give a detailed history of all AI on the page about TheRaven. Consider the article's title as your point of origin and write from that perspective. Make use of the wiki's ability to link to more detailed articles or external sources for more information.

Write from an impersonal perspective. Do not use "I." For example, do not write, "In the years that followed, Ezio began a quest to rediscover the lost history of the Order, As far as I know." Avoid drawing attention to the author (yourself) as much as possible.

Be bold. If you know something is wrong, correct it. If you think you could word something better, write it. If an article has a glaring deficiency, fill it. Even if your first attempt isn't golden, you can fix it later or someone else will come along and fix it for you. Don't be afraid to screw up.

Use present tense. These services, enttitles and policies are active, living, and fluid -- because they're changing now, we use present tense to describe current state.

Images

Images make an article memorable and pretty. They can speak where words fail. At the same time, misplaced or untidy images can detract from an article. When choosing images, keep in mind placement, size, and the appropriateness of the image to the section. Let images flow with the text instead of break it up.

Large images such as screenshots should use the "thumb" (example:[[Image:CoolImage.png|thumb]]) option which displays large images as thumbnails. Images should generally be right aligned to enhance readability by allowing a smooth flow of text down the left margin - the "thumb" option does this by default. If an infobox is not being used in an article, a right aligned picture in the lead section is encouraged.

Images should be kept to a minimal number -- three or fewer inline images per article. High-quality images should be stored in Yggdrasil.

Galleries

When an article has many images, or can be improved by having more, and having inline images can detract from its readability, the use of a section is encouraged. See the #Useful_Snippits for how to implement that.

Galleries should be five images or less. More images than that or exceptionally high-quality images should be in Yggdrasil.

Useful Snippets

Tables

{|class="wikitable"
|-
| Cell 1 || Cell2
|-
|}

Transclusion

This will include an entire other page in yours.

{{:Wiki}}

Internal:

[[Wiki]]
External:
[https://aninix.net/root.php WebServer]

Styling

*Bold*
**Italic**

Images

[[File:Image|thumb|250px|right|Some caption]]
Image:Example.jpg|Caption
Image:Example.jpg|Caption

If/then

{{#if:{{{add|}}}|==Additional Reference
{{{add}}}|}}

Category:Operation