The Garaho Wiki is down due to maintenance. This is a readonly backup version of the Wiki. If you did not expect to see this, please email the webmaster: wiggle at mailbox dot org. Thank you!

wiki logo

Table of Contents

Style Guide

This style guide is to overview style formatting and guidelines used across the wiki to ensure consistency in style.

Editors should use language that is clear, concise, and readable to the average person. If the article content is dense or requires certain knowledge, you are encouraged to link the reader to resources where they can learn more on the subject.

Page types

Pages on the wiki are separated into two main types, info pages and guide pages.

Info pages

Info pages are for general information about a certain subject, such as a certain device. In the context of a specific phone, the page would contain specifications and general information. The page should not include a guide on how to do a certain task. Links should be made to relevant guide pages instead.

Guide pages

Guide pages exist to walk the reader through how to use a certain tool or how to do a certain process. For example the Setting up ADB page gives a brief introduction to ADB as a tool, and walks the user through setting the tool up.

Titles

Titles for guide pages should pertain to the process or tool.

Correct: ====== Setting up cell networks ======

Incorrect ====== Cell networks ======

Correct: ====== Setting up ADB ======

Incorrect ====== ADB ======


Page structure

Titles/Sections

Top Header

Every page should have a top-level header (using `======`) at the very top of the page.

A short paragraph should follow the title providing a brief description of the page contents. It should not feature any additional headings, as search engines will use it in their results. After that, a new section should be created, with any needed headings.

Section header

Titles should be in sentence case, not title case. Proper nouns (like “Kyocera DIGNO Keitai 4”) should remain capitalized.

Correct: ====== SD card limitations ======

Incorrect: ====== SD Card Limitations ======

Correct: ====== Kyocera DIGNO Keitai 4 ======

Incorrect: ====== Kyocera digno keitai 4 ======

Hierarchy

 * Level 1 (======) for 
 * Level 2 (=====) for main sections
 * Level 3 (====) for subsections
 * Level 4 (===) for sub-subsections
 * Deeper sections are to be avoided unless necessary 

Page naming

Namespace headpages are called “start” (e.g. `third_party_apps:start`). Phone page names always start with the manufacturer, followed by the phone name (e.g. `phones:sharp_aquous_keitai_4`).


Links to phone pages should be referenced using their full title the first time they are mentioned in a page. Subsequent links should be truncated to their shortened name (e.g. Kyocera DIGNO Keitai 4 ⇒ DIGNO 4).

Relevant pages/page subsections should be linked inline where possible (e.g. “Additionally, if the default keyboard has been debloated, open UAD and restore the…”).

Links to internal pages should end with “:” (e.g. [[third_party_apps:]]).

External links are permitted if they provide value and quality to the reader. External links should be from trusted sources.


Text formatting

Commas

Use the Oxford comma in lists of three or more items (e.g. phones, phones, and phones).

Romanization

If no officially English name exists for a phone, it is best practice to name the phone using romanized Japanese. Translations can be mentioned later on in the page. For example:

Japanese: かんたん携帯10

Romanization: Kantan Keitai 10

Translation in page: “The phone is sold under the name “Kantan Keitai 10”. “Kantan” roughly translates to simple/easy.”

Sitemap