Help:Formatting

From Rosetta Code

Editing on a wiki site is a bit different from editing plain HTML. While HTML is allowed, there are some extra things.

The Editor[edit]

If you enable JavaScript on your browser, you get a neat little toolbar to help you out with wiki editing. You can use these buttons you help you learn how to do things for yourself. First, there are Bold and Italics buttons. Next, there is a button you can use to link to an internal page, and one you can use to link to an external page. There is a button for making text into a header (like "The Editor" shown above). You can link to an image on the site with the next button:

Fifo.gif

Or to another form of media with the one after that. You can show mathematical formulas in LaTeX with the next button. The next button allows you to show text without wiki formatting in case your language uses text that wiki has reserved for itself (for example, two apostrophes in a row). The next button adds your signature to things (used mostly for talk pages), and the last button adds a horizontal bar, but that gets annoying.

Wiki Formatting on Your Own[edit]

If you would like to break yourself away from the GUI editor options, you can click the "edit" tab on almost any page to see the wikicodes for yourself, or just type the formatting codes in yourself.

'''Bold text'''

''Italic text''

[[InternalLink]] or [[InternalLink|Display title]] to change what words show up on the page for the link.

[externalLink] or [externalLink Display title] to change what words show up on the page for the link.

[[wp:wikipedia link]] or [[wp:wikipedia link|Display title]] to link to a wikipedia page with the name that follows "wp:"

[[oeis:AXXXXXX]] or [[oeis:AXXXXXX|Display title]] where AXXXXXX is the sequence index, to link to an OEIS sequence page. Leading zeros may be omitted. A1 is the same as A000001.

=Big headline= (has horizontal bar, not a button in the JavaScript editor)

==Small headline== (has horizontal bar)

===Medium headline=== (not a button in the JavaScript editor)

[[Image:Example.jpg]]

[[Media:Example.ogg]]

<lang c>C code example</lang>

<math>LaTeX formula</math>

<nowiki>Don't use wiki formatting</nowiki>

Your username: --~~~ (not a button in the JavaScript editor)

Your signature (username, date, and time): --~~~~

Just the date and time: --~~~~~ (not a button in the JavaScript editor)

Horizontal bar: ----

Numbered list example (raw wiki text):

#Item 1
#Item 2
#Item 3

#Item 1

What it displays:

  1. Item 1
  2. Item 2
  3. Item 3
  1. Item 1

*Bulleted text (shown below, not a button in the JavaScript editor)

:Indented text. Use multiple colons to indent multiple times. (not a button in the JavaScript editor)

<tt>Monospaced font text</tt> usually used for talking about commands in sentences. (not a button in the JavaScript editor)

#REDIRECT [[other page]] to redirect visitors of this page to the "other page." (not a button in the JavaScript editor)

[[Category:category page]] to add a page to a category. (shows a link to the category on the bottom of the page, but not in the text...not a button in the JavaScript editor)

[[:Category:category page]] or [[:Category:category page|Display title]] to insert a link to a category page into the text of a page without adding it to the category. (not a button in the JavaScript editor)

Useful Tips, Characters, and Codes[edit]

One way to make sure that your edits have come out just like you want is to preview them before submitting them. Clicking the "Show preview" button before you save your page will show you how the page will look with whatever content you have added, but it won't bother anyone else if it's wrong. Even after all of this it may still not look right, though. So here are a few more tips:

  • To add a newline. simply insert two returns or add a <br>. (the HTML way will be a slightly smaller line break)
  • To add certain math characters (for those with no LaTeX experience) with Windows, hold "Alt" and press the following codes on your keypad (no padding with zeros):
  • 26 → (Implies)
  • 170 ¬ (Not)
  • 224 through 234 αßΓπΣσµτΦΘΩ (Greek letters: alpha, big beta, big gamma, pi, big sigma, little sigma, mu, tau, big phi, big theta, big omega)
  • 236 ∞ (Infinity)
  • 241 through 243 ±≥≤ (Plus/minus, less than/equal to, greater than/equal to)
  • 246 ÷ (Division)
  • 247 ≈ (Approximately)
  • 248 ° (Degrees)
  • 251 √ (Square root. Will not extend across entire formula...parentheses suggested)
  • 253 ² (Squared)
On Linux with German keyboard layout, the following key combinations will usually work:
  • AltGr + U: →
  • AltGr + ^: ¬
  • AltGr + Shift + Q: Ω
  • AltGr + k: ĸ
  • AltGr + m: µ
  • AltGr + .: ·
  • AltGr + ;: ×
  • AltGr + :: ÷
  • AltGr + 1 through 3: ¹²³
  • AltGr + 5: ½
  • AltGr + 4: ¼
  • AltGr + Shift + 2: ⅛
  • AltGr + Shift + 5: ⅜
  • AltGr + Shift + 6: ⅝
  • AltGr + Shift + 7: ⅞
  • AltGr + Shift + 9: ±
In any case, independent of operating system and keyboard layout, you can use the HTML entities:
  • &rarr; →
  • &not; ¬
  • &alpha;&beta;&gamma;&delta;&epsilon;&zeta;&eta;&theta; αβγδεζηθ
  • &iota;&kappa;&lambda;&mu;&nu;&xi;&omicron;&pi; ικλμνξοπ
  • &rho;&sigma;&tau;&upsilon;&chi;&phi;&psi;&omega; ρστυχφψω
  • &Alpha;&Beta;&Gamma;&Delta;&Epsilon;&Zeta;&Eta;&Theta; ΑΒΓΔΕΖΗΘ
  • &Iota;&Kappa;&Lambda;&Mu;&Nu;&Xi;&Omicron;&Pi; ΙΚΛΜΝΞΟΠ
  • &Rho;&Sigma;&Tau;&Upsilon;&Chi;&Phi;&Psi;&Omega; ΡΣΤΥΧΦΨΩ
  • &infin; ∞
  • &plusmn; ±
  • &le;&ge;&ne;&asymp; ≤≥≠≈
  • &middot;&times;&divide; ·×÷
  • &deg; °
  • &radic; √
  • &sup1;&sup2;&sup3; ¹²³
  • To add superscripted text, put <sup></sup> around it. <sup>example</sup> shows example.
  • To add subscripted text, put <sub></sub> around it. <sub>example</sub> shows example.
  • To show your source code in a box, add a <lang> tag with a programming language as an argument:
int main(char* argv, int argc){
printf("Hello, World!");
}

(See Help:Syntax highlighting for language arguments)

  • To show text with wikicode in a code box, add a space before each line (including blank lines):

This is italic text.

This is italic text in a box.
  • To show text without wikicode in a box, add a <pre> tag:

This is italic text.

''This is not italic text in a box, but it shows the wikicode for italics.''
  • Putting two spaces after a period (as is common practice) will only show up as one space when typing plain text. It basically wastes server space.
  • If you have a question about something on a page, ask! Sometimes even we are wrong about coding, so if you think you see a problem or don't understand something, click the "discussion" tab at the top of the page and tell us about it.
  • See Help:Contribute Content for more help on specific types of pages.

Guidelines (not rules)[edit]

  • Spelling and grammar count...PROOFREAD! Firefox has spell check built-in (tools → options → advanced tab → "Check my spelling as I type").
  • When you add programming examples to a page, make sure you insert them in the proper alphabetical order.
  • Case-insensitive
  • Longer words come after shorter words that start with the same sequence ("bar" comes before "barber" and C comes before C++)
  • If you change only a small portion of a page (correcting spelling, adding punctuation, etc.), check the "This is a minor edit" box so that people can filter out typo fixes when they search (adding an entire programming example is not a minor edit).
  • Try to make the most of each edit. Five edits to a page in a ten minute span crowds the recent changes page.
  • Try to add explanation in sentences to more complex examples. Write as if someone who has never heard of your language is reading.
  • Add your signature (--~~~~) to the end of messages on talk pages, and indent responses underneath previous messages:

Message 1.

Response to message 1.
Response to response to message 1.
Second response to message 1.

Message 2.

Response to message 2.

External Links[edit]