Consumer Rights Wiki:Style guide: Difference between revisions

(2 intermediate revisions by one other user not shown)

Line 42:

*Maintain consistent date and number formats throughout

~~=External links=~~

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.

===Quotations and punctuation===

Line 69:

Line 54:

Example: The company stated that their product was "completely secure", but evidence suggested otherwise.

You can also use the <code><blockquote> </blockquote></code> tag to get results like below:

You can also use the <code><blockquote> </blockquote></code> tag in the source editor or click the paragraph button and then block quote in the visual editor 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:<blockquote>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.</blockquote>

Line 101:

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

In general, ~~such in-line page links~~ should ~~only~~ be made to ~~articles~~ on ~~this wiki~~, or on ~~Wikipedia~~. Wikipedia links ~~should be~~ used to provide ~~general~~ context ~~on a topic~~, where an internal ~~wiki~~ link would not be ~~appropriate~~ (e.g. ~~if a politician who~~ does not ~~have~~ a page on ~~this wiki is mentioned~~ in ~~an article~~, then ~~it may~~ be ~~useful~~ to the ~~reader if the Wikipedia~~ article ~~for that person is linked)~~.

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

@@ Line 42: / Line 42: @@
 *Maintain consistent date and number formats throughout
-=External links=
-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.
 ===Quotations and punctuation===
@@ Line 69: / Line 54: @@
 Example: The company stated that their product was "completely secure", but evidence suggested otherwise.
-You can also use the <code>&#x3C;blockquote&#x3E; &#x3C;/blockquote&#x3E;</code> tag to get results like below:
+You can also use the <code>&#x3C;blockquote&#x3E; &#x3C;/blockquote&#x3E;</code> tag in the source editor or click the paragraph button and then block quote in the visual editor 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:<blockquote>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.</blockquote>
@@ Line 101: / 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”.
-In general, such in-line page links should only be made to articles on this wiki, or on Wikipedia. Wikipedia links should be used to provide general context on a topic, where an internal wiki link would not be appropriate (e.g. if a politician who does not have a page on this wiki is mentioned in an article, then it may be useful to the reader if the Wikipedia article for that person is linked).
+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==