Manual of Style

From Freeciv

The Manual of Style contains guidelines and helpful tips for creating and editing content in the Freeciv wiki.

[edit] Recent changes

The developers try to read the Recent changes page frequently to catch vandalism, errors or just useful work by other people. However for this to possible, the 'Recent changes' page has to be reasonably short. So please try to keep your number of edits low by using the preview feature to avoid making too much noise.

To help the regulars reducing this problem a bit there is a setting in the Preferences in the Recent changes and stub display section

[x] Enhanced recent changes (not for all browsers)

Thsi will summarise all changes of one page listed in the Recent changes into one (expandable) entry.

[edit] Keyboard and menu references

To reference a key on the keyboard or a button inside a program you can use the kbd template.

Example:

{{kbd|Enter}}

will give you: Enter

The same thing exists for menu entries and similar: the grey template.

Example:

{{grey|File}}

will give you: File

[edit] Markup of scripts and commandline references

[edit] Single commands

<code>command -parameter</code>

...will give...

command -parameter

Pro

embeddable
additional formatting inside the "code" tags is allowed (not escaped)

Contra

additional formatting inside the "code" tags is allowed (not escaped)

[edit] Scripts and long and/or multiple-line commands

Replace the ( ) with < > in the code below.

(pre)
#! /bin/sh
cp xxx yyy
ln -s yyy xxx
echo "done"
(/pre)

...will give...

#! /bin/sh
cp xxx yyy
ln -s yyy xxx
echo "done"

Pro

multiple lines (line break) without special formatting possible

Contra

not embeddable
no additional formatting inside the "code" tags is allowed (it's escaped)

[edit] Interlanguage pages and links

See the discussion in the talk section of the main page for now:

Talk:Main_Page/archive_1#Create_Freeciv-Wikis_in_other_Languages.3F