Consumer Rights Wiki:Style guide
This guide outlines the writing and formatting standards for Consumer Rights Wiki articles. Our goal is to ensure consistency across articles, while making content clear and accessible to readers. By following these guidelines, we can maintain a professional and reliable resource for documenting anti-consumer behavior.
Article structure
Every article must begin with an introductory lead section, a concise summary of the topic that appears before any headings. The introduction should provide context and define the topic's relevance to anti-consumer behavior. After the introduction, organize your content using clear section headings.
For article organization:
- Place any infoboxes and images in the lead section, right-aligned
- Use sections and subsections to organize content logically
- Do not skip heading levels (e.g., don't jump from level 2 to level 4)
- Only introduce a heading level if there will be more than one item at that level (e.g., if there is a 1.1, there should be a 1.2)
Article titles and headings
Article titles and section headings should be recognizable and precisely descriptive while remaining concise. They should follow sentence case, capitalizing only the first word and proper nouns.
Title formatting requirements:
- Use sentence case (e.g., "Product history", not "Product History")
- Do not begin with articles ("a", "an", "the") unless part of a proper name
- Use nouns or noun phrases (e.g., "Early life", not "In early life")
- Avoid punctuation unless part of a name. Do not use periods
.at the end of titles. - Do not use special characters other than dashes
-, parentheses()and the ampersand&. - When created an article that has a hyphenated title, please create a redirect from the un-hyphenated equivalent page. (eg. "End-user license agreement" and "End user license agreement")
Section heading guidelines:
- Keep headings unique within a page
- Avoid links in headings
- Do not include citations or footnotes in headings
- Do not refer redundantly to the article subject (use "Early life", not "Company's early life")
- Do not phrase headings as questions
Text formatting
Writing style
Consumer Rights Wiki articles should maintain a neutral, factual tone while remaining accessible to general readers. Content should be clear, concise, and well-organized. Avoid needlessly complex sentence structure or terminology, when the same information can be conveyed with simpler constructions. Write as simply as possible while maintaining precision and clarity.
Regional consistency:
- Choose one spelling standard (American or British English) within each article
- Use regional spelling conventions for region-specific topics
- Maintain consistent date and number formats throughout
Quotations and punctuation
We use logical punctuation to enhance clarity in technical documentation. This means placing punctuation where it logically belongs rather than following traditional rules.
Quotation guidelines:
- Use double quotation marks for direct quotes
- Use single quotation marks for quotes within quotes
- Place punctuation outside quotation marks unless part of the quoted text
Example: The company stated that their product was "completely secure", but evidence suggested otherwise.
You can also use the <blockquote> </blockquote> tag to get results like below:
Peter Brabeck-Letmathe, a former chairman and CEO of Nestlé, in the 2005 documentary ``We Feed the World`` shared his opinion on water as a human right:
The one opinion, which I think is extreme, is represented by the NGOs, who bang on about declaring water a public right. That means that as a human being you should have a right to water. That’s an extreme solution.The other view says that water is a foodstuff like any other, and like any other foodstuff it should have a market value.
Boldface and italics
Sometimes it is prudent to denote the importance of a fact using formatting in an article. To achieve this avoid the use of boldface. In general boldface should only be used when automatically applied (for example in section titles or citations). In order to emphasize a term use italics while also trying to avoid overusage or use in overly long sentences to avoid diminishing the effect.
Other acceptable uses for italics include:
- Titles of referenced works in text (e.g. books, articles, documentaries etc)
- Names of court cases
- Non-English language terms
Do not use italics to format quotations, see Quotations and punctuation above.
Numbers and units
For clarity and consistency in numerical content:
- Spell out numbers one through nine in prose
- Use numerals for numbers 10 and above
- Always use numerals for measurements, statistics, and prices (supersedes the above two rules)
- Include commas in numbers over 999 (e.g., 1,000)
- Ranges or connections should use en dashes instead of hyphens, including
- Number ranges: "The estimated number of affected customers was 100–500"
- Year ranges: "Baby Boomers are those people born within the years 1946–1964"
- Name connections: "The New York–London flight takes several hours" or "Gell-Mann is known for his work with Nishijima on the Gell-Mann–Nishijima formula"
- Use the 24-hour clock for times
- Use ISO date format (YYYY-MM-DD) in technical contexts
Initialisms (and acronyms)
The first appearance of an initialisms and acronyms must be spelled out, with the initialism in parentheses (if it is intended to be used in the rest of the article). For instance, do not write “DRM” in an article without having its first appearance in the article rendered as “digital-rights management (DRM)”. Link the expanded term (rather than the initialism) where possible.
Page links
When linking text in articles, only link the first instance within the article. For instance, on an article about a Sony product, do not link each appearance of the word “Sony”.
Citations and References
Reliable sourcing is crucial for establishing the Consumer Rights Wiki's credibility. All factual claims must be supported by citations to reliable sources.
Source requirements:
- Include access dates for online sources
- Archive links should be used where possible to prevent link rot
Citation formatting:
- Place citations at the end of the relevant sentence (or clause), after the period
- Group multiple citations supporting the same statement
- Use ref tags for inline citations
- Provide full source information in the References section
Templates
Templates help maintain consistency across articles and provide structured information. Template names use the PascalCase variation of camel case formatting (e.g., InfoboxProductLine, IncidentSummary).
Common templates include:
- Infoboxes for structured product or company information
- Notice templates for article status
- Citation templates for standardized references
- Navigation templates for related articles
Cargo tables
Cargo is a MediaWiki extension that allows structured data storage and querying. The Consumer Rights Wiki uses Cargo tables to organize information about companies, products, and incidents in a searchable database format.
Cargo tables store structured data from the four Cargo-enabled templates detailed below. When a page uses a Cargo-enabled template, the data is automatically stored in the corresponding database table. This allows for third parties to access programatically defined information on the wiki, such as for the browser extension currently in development.
- Each Cargo table corresponds to a specific template
- Data is stored when pages are saved with the template
- Tables can be queried to generate dynamic content
- Multiple pages can contribute data to the same table
Available Cargo tables
The Consumer Rights Wiki maintains four primary Cargo tables, each with its own form for data entry:
Company table
Used in Company articles
| Field name | Type | Format/Validation | Notes |
|---|---|---|---|
| Founded | Date | YYYY-MM-DD | Month and day optional (YYYY or YYYY-MM also valid) |
| Industry | List of String | Comma-separated | Multiple industries allowed; use existing values when possible |
| Logo | File | PNG/JPG | Upload functionality requires Chromium-based browsers |
| ParentCompany | Page | Wiki page name | Links to another Company page; can enter non-existent companies |
| Type | String | Single value | Legal structure: Public, Private, Non-Profit, Government |
| Website | List of URL | Comma-separated | Only separate TLDs or regional variations |
| Description | String | 150 characters max | Brief company description |
ProductLine table
Used in Product Line articles
| Field name | Type | Format/Validation | Notes |
|---|---|---|---|
| Company | List of Page | Comma-separated | Links to Company pages |
| ReleaseYear | Date | YYYY | Four-digit year only |
| InProduction | Boolean | Checkbox | Whether currently in production |
| ArticleType | String | Product/Service | Specifies type of offering |
| Category | List of String | Comma-separated | Product categories (e.g., Laptop, Desktop, Server) |
| Logo | File | PNG/JPG | Upload functionality requires Chromium-based browsers |
| Website | List of URL | Comma-separated | Only separate TLDs or regional variations |
| Description | String | 150 characters max | Brief product line description |
Product table
Used in Product articles
| Field name | Type | Format/Validation | Notes |
|---|---|---|---|
| Company | List of Page | Comma-separated | Links to Company pages |
| ProductLine | List of Page | Comma-separated | Links to ProductLine pages; existing values only |
| ReleaseYear | Date | YYYY | Four-digit year only |
| InProduction | Boolean | Checkbox | Whether currently in production |
| ArticleType | String | Product/Service | Specifies type of offering |
| Category | List of String | Comma-separated | Product categories |
| Logo | File | PNG/JPG | Upload functionality requires Chromium-based browsers |
| Website | List of URL | Comma-separated | Only separate TLDs or regional variations |
| Description | String | 150 characters max | Brief product description |
Incident table
Used in Incident articles
| Field name | Type | Format/Validation | Notes |
|---|---|---|---|
| Company | List of Page | Comma-separated | Links to Company pages |
| StartDate | Date | YYYY-MM-DD | Month and day optional |
| EndDate | Date | YYYY-MM-DD | Month and day optional; leave blank if ongoing |
| Status | String | Dropdown | Active, Pending Resolution, or Resolved |
| ProductLine | List of Page | Comma-separated | Links to ProductLine pages; existing values only |
| Product | List of Page | Comma-separated | Links to Product pages; existing values only |
| ArticleType | String | Product/Service | Specifies what the incident relates to |
| Type | List of String | Comma-separated | Incident types (e.g., Repairability, Privacy) |
| Description | String | 150 characters max | Brief incident description |
Examples
For a Company entry: {{CompanyCargo |Founded=2003-09-23 |Industry=Electronics,Consumer Devices |Logo=ExampleCorp.png |Type=Public |Website=https://www.examplecorp.com/ |Description=Examplecorp is a manufacturer known for consumer devices }}
For a Product entry: {{Product |ArticleType=Product |Category=Smartphone,Mobile Device |Company=Example Corporation |InProduction=true |ProductLine=Example Phone Series |ReleaseYear=2023 |Website=https://www.examplephone.com/ }}
For an Incident entry: {{Incident |Company=Example Corporation |StartDate=2024-03-15 |Status=Active |Product=Example Phone 15 |Type=Repairability,Planned Obsolescence |Description=Manufacturer blocks third-party repairs through software locks }}