Consumer Rights Wiki:Style guide: Difference between revisions

(6 intermediate revisions by 2 users not shown)

Line 41:

*Use regional spelling conventions for region-specific topics

*Maintain consistent date and number formats throughout

===Quotations and punctuation===

Line 85:

Line 86:

The first appearance of an [[wikipedia:Initialism|initialisms]] and [[wikipedia:Acronym|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===

==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~~==

Aside from internal links, which should be used at the first mention of another article on the CRW within each article, there will also be times when it is suitable to include links to external sites directly within an article's text (as opposed to via a citation/reference). In general this should be kept to a minimum, however the main exceptions to this rule are described below:

===Wikipedia===

A link should be made to Wikipedia when:

* a significant entity is first mentioned in an article, which is not represented on the CRW, or;

* an entity is first mentioned on its own page.

Wikipedia links are used to provide additional context to the reader about entities or concepts involved in an article, where an internal CRW link could not provide such context. they may be used in place of internal CRW in-line links when such an internal link would lead to an empty page. Do not link stub Wikipedia articles, as these are unlikely to provide useful context to the reader.

===iFixit===

At the first mention of the specific product model for an electrical device within an article, an external link should be made to its iFixit page (if extant), as iFixit tends to be the best source for specific model information, and can provide useful context to a reader.

===Official company websites===

The official website of a company, product, or insitiution which is the subject of an article should generally only be linked in the article's infobox. Where the article does not contain an infobox, and there is no similar location to place the link, it may be inserted as a link in text. If a entity has an entity page on the CRW with a link in its infobox to the official company website, then the link at the first mention of the entity within the article should be to the company's CRW article, not to its website.

==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.

Line 101:

Line 118:

*Group multiple citations supporting the same statement

*Use ref tags for inline citations

*Provide full source information in the References section

*Provide full source information in the References section (use [[Template:Cite web|Cite web]] for website references)

==Citations/references vs. page links==

Page links, such as this link to the [[mission statement]], should only be added for the purpose of easing navigation within the site, or to provide general context (except in the case of external links to a company website in an infobox). Such page links should never be used to support a claim made within the text of an article. Instead, where a link is intended to provide support to a claim in the text, a citation to a reference should instead be used.

==Templates==

Line 112:

Line 133:

*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

{| 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:

{{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:

{{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:

{{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]]

@@ Line 41: / Line 41: @@
 *Use regional spelling conventions for region-specific topics
 *Maintain consistent date and number formats throughout
 ===Quotations and punctuation===
@@ Line 85: / Line 86: @@
 The first appearance of an [[wikipedia:Initialism|initialisms]] and [[wikipedia:Acronym|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===
+==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==
+Aside from internal links, which should be used at the first mention of another article on the CRW within each article, there will also be times when it is suitable to include links to external sites directly within an article's text (as opposed to via a citation/reference). In general this should be kept to a minimum, however the main exceptions to this rule are described below:
+===Wikipedia===
+A link should be made to Wikipedia when:
+* a significant entity is first mentioned in an article, which is not represented on the CRW, or;
+* an entity is first mentioned on its own page.
+Wikipedia links are used to provide additional context to the reader about entities or concepts involved in an article, where an internal CRW link could not provide such context. they may be used in place of internal CRW in-line links when such an internal link would lead to an empty page. Do not link stub Wikipedia articles, as these are unlikely to provide useful context to the reader.
+===iFixit===
+At the first mention of the specific product model for an electrical device within an article, an external link should be made to its iFixit page (if extant), as iFixit tends to be the best source for specific model information, and can provide useful context to a reader.
+===Official company websites===
+The official website of a company, product, or insitiution which is the subject of an article should generally only be linked in the article's infobox. Where the article does not contain an infobox, and there is no similar location to place the link, it may be inserted as a link in text. If a entity has an entity page on the CRW with a link in its infobox to the official company website, then the link at the first mention of the entity within the article should be to the company's CRW article, not to its website.
+==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.
@@ Line 101: / Line 118: @@
 *Group multiple citations supporting the same statement
 *Use ref tags for inline citations
-*Provide full source information in the References section
+*Provide full source information in the References section (use [[Template:Cite web|Cite web]] for website references)
+==Citations/references vs. page links==
+Page links, such as this link to the [[mission statement]], should only be added for the purpose of easing navigation within the site, or to provide general context (except in the case of external links to a company website in an infobox). Such page links should never be used to support a claim made within the text of an article. Instead, where a link is intended to provide support to a claim in the text, a citation to a reference should instead be used.
 ==Templates==
@@ Line 112: / Line 133: @@
 *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
+{| 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]]