Wiki style guidelines
About this page
- Original wiki wording
- rev 2045 · 10 Feb 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
Section titled “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
Section titled “Conventions”Add a table of contents wherever possible
Section titled “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
Section titled “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
Section titled “Avoid using abbreviations in page titles”Prefer "Deposit transaction" over "Deposit tx".
Prefer wiki headings over plain bold text
Section titled “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
Section titled “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
Section titled “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
Section titled “Use consistent markup for images”Please try to use the following conventions where appropriate:
- Use
thumbformat - 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
#ff0000color
Use admonition blocks for stand-out warnings and notes
Section titled “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:
Use gerunds for page titles
Section titled “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
Section titled “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.
Source and history
This article keeps its recovered wording, headings, step order and available images. Formatting and links are adapted for this site. The snapshot does not guarantee that every instruction is current.
- Original page
- Wiki style guidelines
- Revision
- 2045 · 10 Feb 2021
- Last recorded editor
- Plebeian9000 (not a complete author list)
- Snapshot
- 18 October 2026
- Source files
- Original wikitext · Revision metadata
- Recovery gaps
- 0 restored historical template occurrences · 0 unresolved templates · 0 unresolved article links · 0 unresolved sections