Difference between revisions of "Wiki Conventions"
From GnuCash
(maint -> stable; use {{Mac}}) |
({{*Url}} -> {{URL:*}}) |
||
| Line 64: | Line 64: | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
! scope="row"|{{WebServer}} | ! scope="row"|{{WebServer}} | ||
| − | |<nowiki>{{ | + | |<nowiki>{{URL:www}}</nowiki> |
| − | |{{ | + | |{{URL:www}} |
|holding the website and the published documentation | |holding the website and the published documentation | ||
| Line 73: | Line 73: | ||
|has serveral aliases: | |has serveral aliases: | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| − | |<nowiki>{{ | + | |<nowiki>{{URL:Build}}</nowiki> |
| − | |{{ | + | |{{URL:Build}} |
|authorative [[Git]] repository, | |authorative [[Git]] repository, | ||
build server of the nightlies ([https://code.gnucash.org/builds/ program], [https://code.gnucash.org/docs/ source docs, documentation]) | build server of the nightlies ([https://code.gnucash.org/builds/ program], [https://code.gnucash.org/docs/ source docs, documentation]) | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| − | |<nowiki>{{ | + | |<nowiki>{{URL:Bugs}}</nowiki> |
| − | |{{ | + | |{{URL:Bugs}} |
|[[Bugzilla]] | |[[Bugzilla]] | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| − | |<nowiki>{{ | + | |<nowiki>{{URL:Lists}}</nowiki> |
| − | |{{ | + | |{{URL:Lists}} |
|[[Mailing Lists]], | |[[Mailing Lists]], | ||
[[IRC]] logs | [[IRC]] logs | ||
| Line 96: | Line 96: | ||
===Linking Source Files === | ===Linking Source Files === | ||
By default link the stable branch <tt>stable</tt>. Only if you are referencing a future feature link <tt>future</tt>. | By default link the stable branch <tt>stable</tt>. Only if you are referencing a future feature link <tt>future</tt>. | ||
| − | :Example: | + | :;Example: <nowiki>{{URL:git}}gnucash/blob/stable/README.dependencies</nowiki>: |
| + | ::{{URL:git}}gnucash/blob/stable/README.dependencies | ||
===Linking Mails=== | ===Linking Mails=== | ||
| − | Sometimes you wish to link a mail. Please use ''our own archives'' at '''{{ListServer}}''' in the form of '''<nowiki>{{ | + | Sometimes you wish to link a mail. Please use ''our own archives'' at '''{{ListServer}}''' in the form of '''<nowiki>{{URL:Lists}}</nowiki>''' instead of any mirror service. |
:;Background: There are several links to empty pages because Gmane lost many pages when it moved in 2016. | :;Background: There are several links to empty pages because Gmane lost many pages when it moved in 2016. | ||
Revision as of 23:22, 28 January 2024
The purpose of this page is
- to unify the appearance of the GnuCash wiki.
- See also
- Wiki Tips
- develope a style, which can be easily converted to DocBook, to move sections into the official documenation.
- See
- DocBook: The Definitive Guide
- See also
- Docbook Conventions
Contents
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
- Insert as first line at least one Category: [[Category:Foo]]
- The current category list
- Note
- Older pages have then often at the bottom of either the abstract or the page. If you see that, move them to the header.
- optional the box of links to translations.
- Continue with usually one sentence abstract. Explain the
- context including links of important related pages,
- specific terms, and
- the planed coverage of the page.
- Finally the first section header starts the text body.
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:
| Template content | Result of the template |
|---|---|
42<noinclude>The Answer to Life, the Universe and Everything</noinclude> |
42 |
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:
| Real Host | Template | URL | Role |
|---|---|---|---|
| www.gnucash.org/ | {{URL:www}} | https://www.gnucash.org/ | holding the website and the published documentation |
| code.gnucash.org | has serveral aliases: | ||
| {{URL:Build}} | https://code.gnucash.org/ | authorative Git repository,
build server of the nightlies (program, source docs, documentation) | |
| {{URL:Bugs}} | https://bugs.gnucash.org/ | Bugzilla | |
| {{URL:Lists}} | https://lists.gnucash.org/ | Mailing Lists,
IRC logs | |
| {{SERVER}} | https://lists.gnucash.org | this wiki.
| |
Please use the respective template in your links.
Linking Source Files
By default link the stable branch stable. Only if you are referencing a future feature link future.
- Example
- {{URL:git}}gnucash/blob/stable/README.dependencies:
- https://github.com/Gnucash/gnucash/blob/stable/README.dependencies
Linking Mails
Sometimes you wish to link a mail. Please use our own archives at lists.gnucash.org in the form of {{URL:Lists}} 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
| Type | You Type | You Get |
|---|---|---|
| Simultaneous (i.e. for change app) | <kbd>Alt</kbd>+<kbd>Tab</kbd> | Alt+Tab |
| Sequential (i.e. for File->Import) | <kbd>Alt</kbd>+<kbd>F</kbd>-<kbd>I</kbd> | Alt+F-I |
| Wrong use, replace it please | <code>Alt</code>+<code>Tab</code> | Alt+Tab
|
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
| Type | You Type | You Get |
|---|---|---|
| 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. |
Feature XGeneral text about Feature X. Gnucash 2.7.0 and newerWe use fee. Gnucash 2.6.20 and beforeWe use foo. |
| Bullet 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 :... and have a 2. paragraph * Gnucash 2.3.1 and before: :We use foo. |
General text about Feature X.
|
| Definition 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 :... and have a 2. paragraph ;Gnucash 2.3.1 and before: We use foo |
General text about Feature X.
|
- Note
- Put newer versions before older versions because in the future they will become more important.
OS Specifics
It is almost the same:
| You Type | You Get |
|---|---|
General text and [https://standards.freedesktop.org standards] like from [https://www.freedesktop.org/wiki/ freedesktop.org].
;Linux: fee
;{{Mac}}: fie
;Windows:
:;NT and newer: foo
:;XP and before: xyzzy
|
General text and standards like from freedesktop.org.
|
This order of OSes is both: historical and alphabetical.
Use the {{Mac}} template because Apple is changing its writing almost every season.
