Difference between revisions of "Wiki Conventions"

From GnuCash
Jump to: navigation, search
m (fix sections)
(→‎Linking GnuCash Servers and List Archives: add templates section)
Line 20: Line 20:
 
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.
 
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.
  
−
==Linking GnuCash Servers and List Archives==
+
==Templates==
−
===Host Overview===
+
Use our [https://wiki.gnucash.org/wiki/index.php?title=Special%3APrefixIndex&prefix=&namespace=10 Templates] where ever possible. This will help to maintain changes of servers, protocoll etc. Currently there are several templates for
−
Currently there a 2 real hosts:
+
* Gnucash *Series/'''*Version'''/*Package and the following
−
;www.gnucash.org: holding the website and the published documentation
+
* *Server/'''*URL''' links:
−
;code.gnucash.org: has serveral aliases:
+
===Linking GnuCash Servers and List Archives===
−
:;code.gnucash.org: authorative [[Git]] repository,
+
====Host Overview====
−
::build server of the nightlies ([https://code.gnucash.org/builds/ program], [https://code.gnucash.org/docs/ source docs, documentation])
+
Currently there a 2 real hosts and several aliases:
−
:;lists.gnucash.org: [[Mailing Lists]],
+
{| class="wikitable"
−
::[[IRC]] logs
+
|-
−
:;wiki.gnucash.org: this wiki.
+
! scope="col"| Real Host
−
Please use the respective alias in your links.
+
! scope="col"| Template
 +
! scope="col"| URL
 +
! scope="col"| Role
 +
 
 +
|- style="vertical-align:top;"
 +
! scope="row"|{{WebServer}}
 +
|<nowiki>{{WebURL}}</nowiki>
 +
|{{WebURL}}
 +
|holding the website and the published documentation
 +
 
 +
|- style="vertical-align:center;"
 +
! scope="row" rowspan="5"|{{BuildServer}}
 +
| colspan="2"|
 +
|has serveral aliases:
 +
|- style="vertical-align:top;"
 +
|<nowiki>{{BuildURL}}</nowiki>
 +
|{{BuildURL}}
 +
|authorative [[Git]] repository,
 +
build server of the nightlies ([https://code.gnucash.org/builds/ program], [https://code.gnucash.org/docs/ source docs, documentation])
 +
|- style="vertical-align:top;"
 +
|<nowiki>{{BugURL}}</nowiki>
 +
|{{BugURL}}
 +
|[[Bugzilla]]
 +
|- style="vertical-align:top;"
 +
|<nowiki>{{ListURL}}</nowiki>
 +
|{{ListURL}}
 +
|[[Mailing Lists]],
 +
[[IRC]] logs
 +
|- style="vertical-align:top;"
 +
|<nowiki>{{SERVER}}</nowiki>
 +
|{{SERVER}}
 +
|this wiki.
 +
;Note:This is no template, but a variable which can be used in ''external'' links, but normally you will use ''internal'' links.
 +
:See also [https://www.mediawiki.org/wiki/Help:Magic_words#Variables Help:Variables] .
 +
|}
 +
Please use the respective template in your links.
 
===Linking Source Files ===
 
===Linking Source Files ===
 
By default link the Maintainance branch <tt>maint</tt>. Only if you are referencing a future feature link <tt>master</tt>.
 
By default link the Maintainance branch <tt>maint</tt>. Only if you are referencing a future feature link <tt>master</tt>.

Revision as of 00:21, 5 February 2019

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

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.

Templates

Use our Templates where ever possible. This will help to maintain changes of servers, protocoll etc. Currently there are several templates for

  • Gnucash *Series/*Version/*Package and the following
  • *Server/*URL links:

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/ {{WebURL}} Template:WebURL holding the website and the published documentation
code.gnucash.org has serveral aliases:
{{BuildURL}} https://code.gnucash.org authorative Git repository,

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

{{BugURL}} https://bugs.gnucash.org Bugzilla
{{ListURL}} https://lists.gnucash.org Mailing Lists,

IRC logs

{{SERVER}} https://lists.gnucash.org this wiki.
Note
This is no template, but a variable which can be used in external links, but normally you will use internal links.
See also Help:Variables .

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, no mirror service.

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

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 X

General text about Feature X.

Gnucash 2.7.0 and newer

We use fee.

Gnucash 2.6.20 and before

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

  • 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
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.
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:

You Type You Get 
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
 General text and standards like from 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

Retrieved from "https://lists.gnucash.org/wiki/index.php?title=Wiki_Conventions&oldid=15068"