Difference between revisions of "Wiki Conventions"

Revision as of 15:52, 2 March 2018

The purpose of this page is to unify the appearance of the GnuCash wiki.

Categories

2-letter categories are reserved:

• Uppercase: ISO region codes like DE (Germany), NO (Norway), ... contain region specific items like setup of tax tables.
• Capitalized: ISO language codes like De page in "german|deutsch" - also readers from AT, CH, ... can use it.

• in theory this should be lowercase, but wikimedia does not accept that.
• at some point in time we might move them in subdomains.

Typography

In commands use the following Syntax:

• <replacable text> like variables like username, path, filename
• [optional text] like optional parameters e.g. gnc-fq-dump [-v] <source> <symbol>...
• alternatives {on|off}
• Repetition ...

Linking GnuCash Servers

Currently there a 2 real hosts:

www.gnucash.org

holding the website and the published documentation

code.gnucash.org

has serveral aliases:

code.gnucash.org

authorative Git repository,

build server of the nightlies (program, source docs, documentation)

lists.gnucash.org

Mailing Lists,

IRC logs

wiki.gnucash.org

this wiki.

Please use the respective alias in your links.

Updating and Versioning

While updating do not remove sections, which might for other users still relevant. Instead create subsections. Depending on the level and complexity it might be

• a subchapter:

==Feature X==
General text about Feature X.
===Gnucash 2.7.0 and newer===
We use fee.
===Gnucash 2.6.20 and before===
We use foo.

• a list:

General text about Feature X.
* Gnucash 2.7.0 and newer:
:We use fee
* Gnucash 2.4.0 to 2.6.20:
:We use fie
* Gnucash 2.3.1 and before:
:We use foo

• or this:

General text about Feature X.
;Gnucash 2.7.0 and newer: We use fee
;Gnucash 2.4.0 to 2.6.20: We use fie
:and have a 2. paragraph
;Gnucash 2.3.1 and before: We use foo

Note

Put newer versions before older versions because in the future they will become more important.

Further Readings

Wiki_Tips