Difference between revisions of "Wiki Conventions"

Revision as of 22:06, 26 July 2021

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 for username, path, filename

alternative in shell scripts:

# Set MYPATH=<where you want to go>
cd "$MYPATH"

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

New Pages

1. Start new pages with an usually one sentence abstract before the first section. Explain the context, specific terms, and the planed coverage of the page.
2. Insert here also at least one Category: [[Category:Foo]]

   The current category list

   Note: Older pages have then often at the bottom. If you see that, move them to the header.

Templates

Use our Templates where ever possible. This will help to maintain changes of servers, protocoll etc.

Comments

Templates can contain comments explaining their meaning and purpose:

42<noinclude>The Answer to Life, the Universe and Everything</noinclude>

Overview

Currently there are several groups of templates:

syntaxhighlighted shell or console snippets

used at several places like english and german version of a page. English comments inside are OK, other language specific parts should stay outside. The template name should end in the type sh or con.

Version

recent or required versions of GnuCash and related software (Aqbanking, F::Q, …) like

Gnucash *Series/*Version/*Package

Links

URLs of our and related servers.

Linking GnuCash Servers and List Archives

Host Overview

Currently there a 2 real hosts and several aliases:

Please use the respective template in your links.

Linking Source Files

By default link the Maintainance branch maint. Only if you are referencing a future feature link master.

Example: https://github.com/Gnucash/gnucash/blob/maint/README.dependencies

Linking Mails

Sometimes you wish to link a mail. Please use our own archives at lists.gnucash.org in the form of {{ListURL}} instead of any mirror service.

Background

There are several links to empty pages because Gmane lost many pages when it moved in 2016.

Keyboard Sortcuts

Subsections

Use subsections for versioning and OS specifics.

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

====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.

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.

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.

OS Specifics

It is almost the same:

General text and [https://standards.freedesktop.org standards] like from [https://www.freedesktop.org/wiki/ freedesktop.org].
;Linux: fee
;MacOS: fie
;Windows:
:;NT and newer: foo
:;XP and before: xyzzy

This order of OSes is both: historical and alphabetical.

Further Readings

Wiki Tips