Wikify
From Sigma Design Wiki
This article explains how to Wikify a Wiki article. It is an annotated, working example of some of the basics of laying out an article. And a summary of what some articles look like. For more complicated articles, you may wish to copy the markup of an existing article that appears to have an appropriate structure.
The Sigma Wiki will have a more consistent appearance if people Wikify the articles to give them a consistent look and feel.
Contents |
First Line
The first line should contain the name of the article. This is because sometimes people are redirected to the article from a different place and it is good to let them know where they are quickly.
Include the name of the article, within triple quote marks '''Article Name''' to produce output like this.
- This Article Name is highlighted in the first line,
Sections
Try to place sections in the article. This makes it easier for users to scan the article. Also, an table of contents is automatically created at the top of the article from the sections.
This section was created by putting e.g.
- ==Sections==
in front of it.
Here is an example of code to make a sub-section:
- ===Sub-Section Name===
to make headings like:
Sub-Section Name
Standard Sections
These are some standard sections which are often used to give articles a consistent look. Use as many of these as you can:
==Overview== ==See also== ==External links==
Fonts
For bold, surround a word with three tic marks (single quotes - ') like this:'''bold'''displays as: bold. For italics, surround a word with two marks (single quotes - ') like this:
''italics''displays as: italics. To set a color and.or size, you can use the < font sequence.
<font color=red size=4>Large Red</font>displays as this: Large Red
Here is an example using font family and # colors:
<font style="font-family: helvetica; font-size: larger; color: #0089E1"> The quick brown fox jumps over the lazy dog.</font>
The quick brown fox jumps over the lazy dog.
Wikify template
If you see an article which needs to be Wikified, you can add the "Wikify" template to it. Template:Wikify This is done by placing the text:
- {{Wikify}} at the top of the article, or section which needs to be wikified.
If you do this, add a comment to the discussion tab of the article to help the author know what you mean, and provide an addition link to this page.
Be Friendly! The author is trying to help out and will appreciate tips on how to create more consistant articles.
Other tips
Exernal Links
First paragraph
The title or subject should almost always be part of the first sentence or elsewhere in the first paragraph.
- Eraser tool deletes edges and most other entities like construction lines when it is hovered over them while left clicking.
'''Eraser tool''' deletes [[edge]]s and most other entities like [[construction line]]s when it is hovered over them while left clicking.
If the subject of the article has more than one name, each new form of the name should be in bold on its first appearance.
- Sodium hydroxide , also known as caustic soda or lye...
'''Sodium hydroxide''' ([[sodium|Na]][[oxygen|O]][[hydrogen|H]]), also known as '''caustic soda''' or '''lye'''....
If an article's title has a parenthetical disambiguator, it should not be included in the bold text.
- Mirror (plugin) should start with "Mirror is a ruby script...", not "Mirror (plugin) is a ruby script...".
Avoid links in the bold title words, and avoid circular definitions. However, most words describing titles should be linked to more detail.
- Buddhist meditation, meditation used in the practice of Buddhism, "includes any method of meditation that has Enlightenment as its ultimate aim." (Kamalashila 1996)
'''Buddhist meditation''', [[meditation]] used in the practice of [[Buddhism]], "includes any method of meditation that has Enlightenment as its ultimate aim." (Kamalashila 1996)
