Consumer Rights Wiki

Consumer Rights Wiki:Style guide: Difference between revisions

← Older edit
VisualWikitext
Fixed some misspellings and typos. Changed "supercedes" to "supersedes" as supersedes is the standard spelling but I *believe* both are correct.
Adding cargo tables to style guide in prep for later. Might move them elsewhere later but for now I think they work here.
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
This guide outlines the writing and formatting standards for CAT 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.
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==
==Article structure==
Line 34: Line 34:


===Writing style===
===Writing style===
CAT 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.
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:
Regional consistency:
Line 89: Line 89:


==Citations and References==
==Citations and References==
Reliable sourcing is crucial for establishing CAT Wiki's credibility. All factual claims must be supported by citations to reliable sources.
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:
Source requirements:
Line 112: Line 112:
*Citation templates for standardized references
*Citation templates for standardized references
*Navigation templates for related articles
*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.


[[Category:CAT]]
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
 
{| class="wikitable"
! 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
 
{| class="wikitable"
! 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
 
{| class="wikitable"
! 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
 
{| class="wikitable"
! 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:
<nowiki>
{{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
}}
</nowiki>
 
For a Product entry:
<nowiki>
{{Product
|ArticleType=Product
|Category=Smartphone,Mobile Device
|Company=Example Corporation
|InProduction=true
|ProductLine=Example Phone Series
|ReleaseYear=2023
|Website=https://www.examplephone.com/
}}
</nowiki>
 
For an Incident entry:
<nowiki>
{{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
}}
</nowiki>
 
 
[[Category:CRW]]
Retrieved from "https://consumerrights.wiki/Consumer_Rights_Wiki:Style_guide"