Difference between revisions of "Wiki style guidelines"

From Bisq Wiki
Jump to navigation Jump to search
(add guideline on commercial links)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
Generally the Bisq wiki follows the [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style] and conventions from other established wikis like the [https://en.bitcoin.it/wiki/Main_Page Bitcoin Wiki].
 +
 +
See exceptions and additions below.
 +
 
__TOC__
 
__TOC__
  
−
== General guidelines ==
+
== Structure of the wiki ==
−
There are three general types of information that almost every form of information can be segregated into:
+
There are three general categories that can be applied to almost every article:
 
* Concepts
 
* Concepts
−
* Tasks (procedures)
+
* Procedures/Use Cases
 
* References
 
* References
  
−
For clarity it is best that these three types of information not be intermingled. For example, you do not want to step through a lengthy task to find a file name, nor would you want to search for a file name in a description of a feature.
+
Please keep articles in one of these distinct categories. For example, there's the ''concept'' of a [[data directory]] and a ''use-case'' of [[Switching_to_a_new_data_directory|switching to a new data directory]]. Each item should have its own article.
 +
 
 +
== Conventions ==
 +
 
 +
=== Add a table of contents wherever possible ===
 +
 
 +
In case an article doesn't automatically include a table of contents, please add one after the introductory text with <code><nowiki>__TOC__</nowiki></code>.
 +
 
 +
=== Avoid repetition ===
 +
 
 +
The wiki is a huge, growing repository of knowledge that will require much time to maintain. Please avoid replicating content in more than one place—it makes keeping the wiki up-to-date harder.
 +
 
 +
If you do find the need to repeat something, use a [https://www.mediawiki.org/wiki/Transclusion transclusion].
 +
 
 +
Practically, this is how it works:
 +
* Create a new page titled <code>Template:Content_to_be_replicated</code>.
 +
* Include <code><nowiki>{{Content_to_be_replicated}}</nowiki></code> anywhere you need it.
 +
 
 +
=== Avoid using abbreviations in page titles ===
 +
 
 +
Prefer "Deposit transaction" over "Deposit tx".
 +
 
 +
=== Prefer wiki headings over plain bold text ===
 +
 
 +
Wiki headings appear in the table of contents, but other text doesn't, so it's better to use headings for big ideas. Furthermore, wiki headings have their own anchor links, making it possible to link directly to particular sections of a page.
 +
 
 +
=== Use code blocks for UI elements ===
 +
 
 +
Denote user interface (UI) elements like tabs and buttons with literal markup (e.g., Click <code>Start</code>). Markup for this styling is <code><nowiki><code></code></nowiki></code>.
 +
 
 +
=== Make software screenshots aesthetically consistent ===
 +
 
 +
For full screenshots of Bisq, please try to make sure:
 +
* Bisq is at the original window size
 +
* Bisq is in light mode
 +
* Don't include your operating system's window border
 +
 
 +
These conventions will help screenshots appear more aesthetically consistent across the wiki.
 +
 
 +
=== Use consistent markup for images ===
 +
 
 +
Please try to use the following conventions where appropriate:
 +
* Use <code>thumb</code> format
 +
* Align left
 +
* Make 600px wide
 +
* Add a concise caption
 +
 
 +
Example:
 +
 
 +
<code><nowiki>[[File:Find-wallet-seed-words.png|thumb|left|600px|Location of wallet seed words and date.]]</nowiki></code>
 +
 
 +
It would be extra nice (but not required) to use the following conventions for '''marking''' images:
 +
* Use [[images/9/99/Arrow-screenshot.png|this arrow]]
 +
* Make any markup 6px wide in the <code>#ff0000</code> color
 +
 
 +
=== Use admonition blocks for stand-out warnings and notes ===
  
−
An example of a good procedure is [https://bisq.wiki/Backing_up_your_wallet Backing up your wallet]. It has a title with a gerund (Back'''ing'''), and a brief conceptual introduction followed by a step-by-step task.
+
Use <code>Template:Admonition_Warn</code> for warnings and <code>Template:Admonition_Note</code> for notes. Both templates take arguments.  
  
−
==Style guide references==
+
So this markup:
−
The Bisq wiki adheres to the Wikipedia Manual of Style whenever possible. There are some styles that Wikipedia does not cover. They are documented in '''Exceptions from Wikipedia''' below.
 
  
−
* [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style <big>Wikipedia Manual of Style</big>]
+
<nowiki>{{Admonition_Warn|Avoid this! It might cause an explosion.}}</nowiki>
−
* [http://en.wikipedia.org/wiki/Wikipedia:Images <big>Wikipedia Images</big>]
 
−
* [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet <big>Wikipedia editing Cheatsheet</big>]
 
  
−
== Exceptions from Wikipedia ==
+
Results in this output:
  
−
=== Non-English language articles  ===
+
{{Admonition_Warn|Avoid this! It might cause an explosion.}}
−
Until there is a need for separate language wikis, create articles in the non English language with the English translation in comments. See [[Running Bisq in China]] as an example.
 
  
−
=== Procedures  ===
+
=== Use gerunds for page titles ===
−
The Bisq wiki contains many procedures. The Wikipedia Manual of Styles does not include styles for technical tasks and procedures therefore the Microsoft style guide has excellent guidance for  [https://docs.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions Writing step-by-step instructions].
 
  
−
====Procedure titles====
+
Use gerunds for page titles (e.g., "Switch'''ing''' data directories" instead of "Switch data directory" and "Updat'''ing''' trade fees" instead of "Update trade fees").
−
Use gerunds (. . . ing) for procedural titles. For example, "Back up your wallet" should be "Back'''ing''' up your wallet". Using a gerund implies you will be performing a process.
 
  
−
=== Tabs, buttons and UI elements ===
+
=== Avoid commercial links ===
−
User interface (UI) elements such as tabs and buttons are indicated in '''bold''' text.
 
  
−
===Describing UI elements===
+
Links to promote other businesses or products should be avoided. Exceptions may be made on a case-by-case basis upon discussion with other contributors.
−
When referring to a user action, simply state "click '''Start'''", it is not necessary to state "click the '''Start''' button".
 

Latest revision as of 18:52, 10 February 2021

Generally the Bisq wiki follows the Wikipedia Manual of Style and conventions from other established wikis like the Bitcoin Wiki.

See exceptions and additions below.

Structure of the wiki

There are three general categories that can be applied to almost every article:

  • Concepts
  • Procedures/Use Cases
  • References

Please keep articles in one of these distinct categories. For example, there's the concept of a data directory and a use-case of switching to a new data directory. Each item should have its own article.

Conventions

Add a table of contents wherever possible

In case an article doesn't automatically include a table of contents, please add one after the introductory text with __TOC__.

Avoid repetition

The wiki is a huge, growing repository of knowledge that will require much time to maintain. Please avoid replicating content in more than one place—it makes keeping the wiki up-to-date harder.

If you do find the need to repeat something, use a transclusion.

Practically, this is how it works:

  • Create a new page titled Template:Content_to_be_replicated.
  • Include {{Content_to_be_replicated}} anywhere you need it.

Avoid using abbreviations in page titles

Prefer "Deposit transaction" over "Deposit tx".

Prefer wiki headings over plain bold text

Wiki headings appear in the table of contents, but other text doesn't, so it's better to use headings for big ideas. Furthermore, wiki headings have their own anchor links, making it possible to link directly to particular sections of a page.

Use code blocks for UI elements

Denote user interface (UI) elements like tabs and buttons with literal markup (e.g., Click Start). Markup for this styling is <code></code>.

Make software screenshots aesthetically consistent

For full screenshots of Bisq, please try to make sure:

  • Bisq is at the original window size
  • Bisq is in light mode
  • Don't include your operating system's window border

These conventions will help screenshots appear more aesthetically consistent across the wiki.

Use consistent markup for images

Please try to use the following conventions where appropriate:

  • Use thumb format
  • Align left
  • Make 600px wide
  • Add a concise caption

Example:

[[File:Find-wallet-seed-words.png|thumb|left|600px|Location of wallet seed words and date.]]

It would be extra nice (but not required) to use the following conventions for marking images:

  • Use this arrow
  • Make any markup 6px wide in the #ff0000 color

Use admonition blocks for stand-out warnings and notes

Use Template:Admonition_Warn for warnings and Template:Admonition_Note for notes. Both templates take arguments.

So this markup: 

{{Admonition_Warn|Avoid this! It might cause an explosion.}}

Results in this output:

Warn
 Avoid this! It might cause an explosion.

Use gerunds for page titles

Use gerunds for page titles (e.g., "Switching data directories" instead of "Switch data directory" and "Updating trade fees" instead of "Update trade fees").

Avoid commercial links

Links to promote other businesses or products should be avoided. Exceptions may be made on a case-by-case basis upon discussion with other contributors.

Retrieved from "https://bisq.wiki/index.php?title=Wiki_style_guidelines&oldid=2045"