FARPN

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Contributing to the FARPN Wiki / Style Guide ======

Contributions to the FARPN Wiki are welcome and encouraged!  Cleaning up or editing an existing page, or adding new pages and tutorials are great ways to get involved.  Please reach out via our Matrix chat in the ''#Wiki'' room in order to get started.  We'll get you set up with an account, and answer any questions you might have.

See [[https://www.dokuwiki.org/wiki:syntax|DokuWiki syntax help page]] for documentation on formatting.

===== Wiki Page Requirements =====
These are the only strict rules around editing the wiki.

  - Thou shalt use alt-text to describe images.
  - Do not copy-and-paste from other pages to create pages here (except for N6CTA's blog).  If you are incorporating a substantial piece of material, make sure that it falls under a permissible license to post it here.

Everything else below are //best practices// we want to encourage, primarily focused on formatting to make things consistent.  But the goal here is to contribute, so this should be viewed as helpful tips, not a list of rules.

===== Style Guide =====
//Have an idea for a new page, or an inkling of one?// Check the [[drafts|drafts]] page before starting an article, it's possible someone else stubbed something out.  There's also the [[todo|ToDo list]] if you've got a spark of an idea but not time to create a page.

==== Writing Style ====
Try not to write in the first person, but writing tutorials with "we" and "you" is acceptable. //When editing, try to follow the existing writing style than completely rewriting it.//

Where possible, be clear and concise.

Keep examples as simple as possible.  Clearly denote what parts of examples must be changed by the person following them.  It is good to define the information to change before providing example text.

Clearly state when things are optional, or may only apply in certain situations.

Specify the filename and suggested location before providing any example text.

==== Formatting ====
Use <code>''two-single-quotes''</code> around command line programs and filenames.

Put ''<code></code>'' tags around any big blocks of configuration files or program examples.  Use a ''$'' in front of lines that show running commands.

Use headings liberally, with the highest level heading for the page title, sections with the second highest level, and sub-sections with the third highest level.  Do not skip levels of headings.