ProleWiki:Editorial guidelines: Difference between revisions

From ProleWiki, the proletarian encyclopedia
m (Provided a less "hacky" solution for example headers that do not interfere with the TOC)
Tag: Visual edit: Switched
m (Shortened quote)
Tag: Visual edit
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Title|''Editorial guidelines of ProleWiki''}}We have editorial conventions that help maintain a consistent style throughout the whole wiki. This discusses mainly form, not content.
{{Title|ProleWiki editorial guidelines}}We have editorial conventions that help maintain a consistent style throughout the whole [[ProleWiki|wiki]]. This discusses mainly form, not content.


Don't forget that the best way to learn how we can maintain a consistent style is by looking at how other articles are built. You can suggest changes in the [[ProleWiki talk:Editorial conventions|discussion page]].
Don't forget that the best way to learn how we can maintain a consistent style is by looking at how other articles are built. You can suggest changes in the [[ProleWiki talk:Editorial conventions|discussion page]].


==Content pages==
==Content pages==
ProleWiki currently does not favor any regional variant of English spelling, so do not make edits just to change spellings to a certain country's variants.
===Title===
===Title===
<ol style="list-style-type:upper-roman">
 
<li>Use preferably sentence case in the title of our articles except in the case for proper nouns.
* Use '''sentence case''' in the title of our articles except in the case for proper nouns (only the first word of a sentence and proper nouns are capitalized).<blockquote class="toccolours">The economic basis of the withering away of the state ('''do''')<br>The Economic Basis of the Withering Away of the State ('''don't''')</blockquote>
<blockquote class="toccolours">The economic basis of the withering away of the state ('''do''')<br>The Economic Basis of the Withering Away of the State ('''don't''')</blockquote>
 
<li>Use common names for titles, for the sake of improved readability. Full names (of persons) or official names (of countries or organizations) should be listed out in the first sentence, after the first bold mention of the common name.  
* For countries, use the official state's name when titling a page. For example, our page is titled [[Russian Federation]], with ''Russia'' redirecting there as the Federation is the most current incarnation of what is called Russia. Likewise, ''China'' redirects to the [[People's Republic of China]].
example: "'''Russia''', officially the '''Russian Federation''', is a country ... "  
** For former countries, include the years it existed in parentheses after the official name and connect the years with an en dash (–), not a hyphen (-). For example, [[Union of Soviet Socialist Republics (1922–1991)]].
<li>Be as specific as needed. For instance, Russian revolution can mean both the 1905 Russian bourgeois revolution and the [[Russian revolution of 1917|1917 Russian socialist revolution]]. In this case, a title which already disambiguates this difference is ideal.
* For people, use the most common name using the Latin alphabet, but remaining in the original language. See for example [[Deng|Deng Xiaoping]] (pinyin), [[Maximilien de Robespierre]] (not the entire name but the most common one), [[Hồ Chí Minh]] (with Vietnamese diacritics), [[Muammar Gaddafi]] (common transliteration from the original Arabic). Create redirects as needed to cover all possible spellings you can think of as well as alternate names.
</ol>
** Transgender people should use their chosen names for the title and have a redirect from the dead name. The dead name should not be mentioned in the main page.
** Hungarian and Japanese names should be written in their native order, which puts the family name first and given name second like Chinese and Korean names do. Write [[Abe Shinzō]] instead of Shinzō Abe, for example.
** For monarchs, treat the dynasty name as their last name and add their regnal number in Roman numerals between their first and last name if necessary. For example, [[Elizabeth II Windsor]].
** Pages about individuals should be sorted based on their surname and then personal name. If this does not match the order in the title page, set the page to sort as ''surname'', ''personal name''<nowiki> In the source editor, add {{DEFAULTSORT:</nowiki>''surname'', ''personal name''<nowiki>}} to the bottom of the page. In the visual editor, go to options --> categories and add this order under "Sort this page by default as." </nowiki>
* Be as specific as needed. For instance, the ''Russian revolution'' can mean both the [[Russian revolution of 1905|1905 Russian bourgeois revolution]] or the [[Russian revolution of 1917|1917 Russian socialist revolution]]. In this case, a title which already disambiguates this difference is recommended.


===Body===
===Body===
<ol style="list-style-type:upper-roman">
<ol style="list-style-type:upper-roman">
<li>In the introductory paragraph of an article, use '''bold''' for when the subject of the article is ''first'' mentioned. This ensures the subject of the article is cited more clearly.</ol>
<li>In the introductory paragraph of an article, use '''bold''' for when the subject of the article or any synonyms are ''first'' mentioned. This ensures the subject of the article is defined more clearly.</ol>
<blockquote class="toccolours">
<blockquote class="toccolours">
<div style="margin-bottom:0.25em; padding: 0;line-height: 1.3; border-bottom: 1px solid #a2a9b1;"><span style="font-size:1.5em;font-family: 'Linux Libertine','Georgia','Times',serif;">Historical materialism</span></div>
<div style="margin-bottom:0.25em; padding: 0;line-height: 1.3; border-bottom: 1px solid #a2a9b1;"><span style="font-size:1.5em;font-family: 'Linux Libertine','Georgia','Times',serif;">Historical materialism</span></div>
Line 21: Line 27:
'''Historical materialism''' broadly refers to applying the philosophy of dialectical materialism to the study of social life.
'''Historical materialism''' broadly refers to applying the philosophy of dialectical materialism to the study of social life.
</blockquote>
</blockquote>
<ol style="list-style-type:upper-roman" start="2">
 
<li>Bluelinking: Blue links made to other articles should be made only when they are ''first'' introduced in the article. This is to prevent readers from getting distracted by excessive use of blue links.
==== Bluelinking and redlinking ====
<small>(note how the second mention of Marxist-Leninist is not linked in the example)</small>
I. Bluelinking: Blue links made to other articles should be made only once, when they are ''first'' introduced in the article. This is to prevent readers from getting distracted by excessive use of blue links. Blue links can also be repeated inside infoboxes (appearing once in the infobox, and once in the body).
</ol>
<small>(note how the second mention of Marxist-Leninist is not linked in the example)</small><blockquote class="toccolours">
<blockquote class="toccolours">
ProleWiki is a [[Marxism–Leninism|Marxist–Leninist]] encyclopedia founded in September 2020 aiming to make information accessible to [[Revolution|revolutionaries]] and those who wish to study revolutionary theory. We stand for the principles of anti-imperialism and we aim to combat the liberal hegemony in Western society by presenting a Marxist-Leninist understanding of political economy.
ProleWiki is a [[Marxism–Leninism|Marxist–Leninist]] encyclopedia founded in September 2020 aiming to make information accessible to [[Revolution|revolutionaries]] and those who wish to study revolutionary theory. We stand for the principles of anti-imperialism and we aim to combat the liberal hegemony in Western society by presenting a Marxist-Leninist understanding of political economy.
</blockquote>
</blockquote>II. Blue links should also strictly be made in body text, never in headings. This is for readability reasons and coherence.


<ol style="list-style-type:upper-roman" start="3">
III. External links '''should not''' be used in the main body. If you need to use an external link as reference, then use it as citation. You can also create an "External links" section at the bottom and put external sources there.
<li>External links '''should not''' be used in the main body. If you need to use an external link as reference, then use it as citation. You can also create an "External links" section and put external sources there.</ol>


====Citations====
====Citations====
Line 38: Line 42:


<ol style="list-style-type:upper-roman" start="2">
<ol style="list-style-type:upper-roman" start="2">
<li>Avoid placing a citation before punctuations</ol>
<li>Avoid placing a citation before punctuation</ol>
<blockquote class="toccolours">Without revolutionary theory,<sup>[1]</sup> there can be no revolutionary movement.<sup>[2]</sup> ('''do''')<br>Without revolutionary theory<sup>[1]</sup>, there can be no revolutionary movement<sup>[2]</sup>. ('''don't''')</blockquote>
<blockquote class="toccolours">Without revolutionary theory,<sup>[1]</sup> there can be no revolutionary movement.<sup>[2]</sup> ('''do''')<br>Without revolutionary theory<sup>[1]</sup>, there can be no revolutionary movement<sup>[2]</sup>. ('''don't''')</blockquote>
==== Naming conventions ====
When referring to someone with an abbreviated name, generally use their surname; for example, when not using [[Friedrich Engels]]'s full name, say 'Engels' instead of 'Friedrich.' However, Vietnamese names are an exception and use the second (given) name. Mongolian names only have a patronymic or matronymic and then personal name with no surname, and Icelandic names have a given name and then patronymic. In both cases, the given name should be used.


===References ===
===References ===
To format your citations, you can create a reference, click on "Cite" and choose "Basic" or press CTRL+SHIFT+K in Visual Editor, then you use the [[Template:Textcite|Textcite template]] and fill the information you have.This will produce a text like this:<blockquote>{{Textcite|author=Author|year=Year|title=Title of book in italics|pdf=|publisher=Publisher|isbn=12312312|lg=https://librarygenesislink.ex}}</blockquote>This is a preferred method because as a template, we can decide to change our formatting style, and it will make the changes in every place it is used.
Use our [[Template:Citation|Citation template]] for books and scientific articles, and the [[Template:Web citation|Web citation template]] for material usually available online or periodicals, newspapers, etc. These options are available through Visual Editor.


If you wish to write it manually, you can generally follow these guidelines:
=== Order of final headings ===
The end of a page must always follow this order in its headings:<blockquote>See also [links to other internal pages]


====Books====
Further reading [links to books or articles in the library]
<blockquote class="toccolours">Author (Year). ''Title of book in italics.'' Publisher. ISBN [number] (Library Genesis link)<br>Author (Year). 'Chapter inside single quotes' in ''Title of book in italics.'' Publisher. ISBN [number] (Library Genesis link)</blockquote>
 
Example in practice:
External links [links to outside pages]
<blockquote class="toccolours">John M. Kirk (2015). ''Healthcare without borders: understanding Cuban medical internationalism.'' University Press of Florida. <nowiki>ISBN 0813061059</nowiki> ([http://libgen.rs/book/index.php?md5=0F7B2ED4B81FB72B92FC080A9B28365A Library Genesis link])<br>Clifford L. Staten (2005). 'Early Cuba: colonialism, sugar and nationalism: Cuba to 1868' in ''The history of Cuba.'' Palgrave Macmillan. <nowiki>ISBN 9781403962591</nowiki> ([http://libgen.rs/book/index.php?md5=DE11DAA6342FE92307FDE6B81E5FD1CF Library Genesis link])</blockquote>
 
Notes
 
References</blockquote>


====Articles====
<blockquote class="toccolours">
Author (Year). ''Title in italics.'' City: Publisher. doi:[code] (Sci-Hub link)
</blockquote>
Example in practice:
<blockquote class="toccolours">
Dic Lo (2020). ''State-owned enterprises in Chinese economic transformation: Institutional functionality and credibility in alternative perspectives''. Journal of Economic Issues. {{Doi|10.1080/00213624.2020.1791579}}
</blockquote>
For articles with a doi code available, you can use our [[Template:Doi|doi template]]
==Library==
==Library==
It was decided that when importing library works, we will not remove sections from the source or edit sentences in other ways. However, it was decided that we are allowed to add a foreword of our own as well as our own footnotes (called annotations) like so:
===Library work infobox===
*Books should all contain the [[Template:Library work]]<nowiki> infobox (call it with two curly brackets {{ }} ). The infobox should include at least the work's </nowiki>'''title, author,''' '''publication''' '''year''' and the '''source''' (either link to PDF or text or "X publisher edition" if taken from paper copy). It will automatically retitle the page according to the first two parameters. Ideally, the infobox should use as many parameters as possible.
=== Library foreword ===
* We can add our own foreword to contextualize the text, explain why the reader should read it, explain that we've added our own footnotes but have not removed anything from the text.
* Use the [[Template:Foreword]] and populate the parameters, it will create the heading itself as well as any necessary styling.
* Remember that your foreword represents ProleWiki as a whole.
=== Library annotations ===
* Add a "basic" citation (Ctrl+Shift+K), and put it in the '''ProleWiki''' group like this<ref group="ProleWiki">Note 1</ref>
* Preferably add annotations at the end of a paragraph.
* Use sparingly, only to add corrections or '''important''' context.
* Editors without the [[ProleWiki:Trusted Editor Permissions|trusted role]] should confirm their footnotes with the trusted editors before saving them on a page.
* References list should be at the end of the chapter or the end of the text, as a subheading nested ''under'' the editor's references, and called "ProleWiki annotations." Example:
=== Notes (<-- subheading 1) ===
<nowiki>*</nowiki>editor's footnotes from original text
==== ProleWiki annotations (<-- subheading 2) ====
<references group="ProleWiki" />
=== Acceptable edits to original text ===
==== Spelling variations of proper nouns ====
If a library work contains an outdated spelling or Romanization of a place name or personal name, add the modern spelling in brackets afterwards:<blockquote>In December 1905 a Bolshevik Conference was held in Tammerfors [Tampere], Finland. ([[Library:History of the Communist Party of the Soviet Union|''History of the Communist party of the Soviet Union'']])</blockquote>
==== Units of measurement ====
If a library work contains non-Metric units of measurement, add the Metric equivalent in brackets afterwards. For example:<blockquote>It should be mentioned that in 1937 the collective farms alone (without the state farms) produced a marketable surplus of over 1,700,000,000 poods [28,000,000 tonnes] of grain, which was at least 400,000,000 poods [6,600,000 tonnes] more than the landlords, kulaks and peasants together marketed in 1913. (''History of the Communist Party of the Soviet Union'')</blockquote>In this example, the pood is a traditional Slavic unit of weight equal to 16.38 kg.
== See also ==
* [[ProleWiki:Code of conduct|ProleWiki's code of conduct]]
* [[ProleWiki:Principles|ProleWiki's principles]]


===Title===
*Book titles should be written in ''italics'', followed by author. To do that, you can use the [[Template:Title|Title template]]. This is done so to differentiate articles written about the book in the main pages from the book itself in our library.
<blockquote class="toccolours">
<div style="margin-bottom:0.25em; padding: 0;line-height: 1.3; border-bottom: 1px solid #a2a9b1;"><span style="font-size:1.5em;font-family: 'Linux Libertine','Georgia','Times',serif;">On authority'', by Friedrich Engels</span></div>
<p style="font-size:85%">From ProleWiki, the proletarian encyclopedia</p>
A number of Socialists have latterly launched a regular crusade against what they call the principle of authority. It suffices to tell them that this or that act is authoritarian for it to be condemned. This summary mode of procedure is being abused to such an extent that it has become necessary to look into the matter somewhat more closely. (...)
</blockquote>
[[Category:Contribute to ProleWiki]]
[[Category:Contribute to ProleWiki]]

Latest revision as of 23:01, 5 June 2024

We have editorial conventions that help maintain a consistent style throughout the whole wiki. This discusses mainly form, not content.

Don't forget that the best way to learn how we can maintain a consistent style is by looking at how other articles are built. You can suggest changes in the discussion page.

Content pages

ProleWiki currently does not favor any regional variant of English spelling, so do not make edits just to change spellings to a certain country's variants.

Title

  • Use sentence case in the title of our articles except in the case for proper nouns (only the first word of a sentence and proper nouns are capitalized).

    The economic basis of the withering away of the state (do)
    The Economic Basis of the Withering Away of the State (don't)

  • For countries, use the official state's name when titling a page. For example, our page is titled Russian Federation, with Russia redirecting there as the Federation is the most current incarnation of what is called Russia. Likewise, China redirects to the People's Republic of China.
  • For people, use the most common name using the Latin alphabet, but remaining in the original language. See for example Deng Xiaoping (pinyin), Maximilien de Robespierre (not the entire name but the most common one), Hồ Chí Minh (with Vietnamese diacritics), Muammar Gaddafi (common transliteration from the original Arabic). Create redirects as needed to cover all possible spellings you can think of as well as alternate names.
    • Transgender people should use their chosen names for the title and have a redirect from the dead name. The dead name should not be mentioned in the main page.
    • Hungarian and Japanese names should be written in their native order, which puts the family name first and given name second like Chinese and Korean names do. Write Abe Shinzō instead of Shinzō Abe, for example.
    • For monarchs, treat the dynasty name as their last name and add their regnal number in Roman numerals between their first and last name if necessary. For example, Elizabeth II Windsor.
    • Pages about individuals should be sorted based on their surname and then personal name. If this does not match the order in the title page, set the page to sort as surname, personal name In the source editor, add {{DEFAULTSORT:surname, personal name}} to the bottom of the page. In the visual editor, go to options --> categories and add this order under "Sort this page by default as."
  • Be as specific as needed. For instance, the Russian revolution can mean both the 1905 Russian bourgeois revolution or the 1917 Russian socialist revolution. In this case, a title which already disambiguates this difference is recommended.

Body

  1. In the introductory paragraph of an article, use bold for when the subject of the article or any synonyms are first mentioned. This ensures the subject of the article is defined more clearly.
Historical materialism

From ProleWiki, the proletarian encyclopedia

Historical materialism broadly refers to applying the philosophy of dialectical materialism to the study of social life.

Bluelinking and redlinking

I. Bluelinking: Blue links made to other articles should be made only once, when they are first introduced in the article. This is to prevent readers from getting distracted by excessive use of blue links. Blue links can also be repeated inside infoboxes (appearing once in the infobox, and once in the body).

(note how the second mention of Marxist-Leninist is not linked in the example)

ProleWiki is a Marxist–Leninist encyclopedia founded in September 2020 aiming to make information accessible to revolutionaries and those who wish to study revolutionary theory. We stand for the principles of anti-imperialism and we aim to combat the liberal hegemony in Western society by presenting a Marxist-Leninist understanding of political economy.

II. Blue links should also strictly be made in body text, never in headings. This is for readability reasons and coherence.

III. External links should not be used in the main body. If you need to use an external link as reference, then use it as citation. You can also create an "External links" section at the bottom and put external sources there.

Citations

  1. Avoid placing a citation after a space

Jeff Bezos is a parasite.[1] (do)
Jeff Bezos is a parasite. [1] (don't)

  1. Avoid placing a citation before punctuation

Without revolutionary theory,[1] there can be no revolutionary movement.[2] (do)
Without revolutionary theory[1], there can be no revolutionary movement[2]. (don't)

Naming conventions

When referring to someone with an abbreviated name, generally use their surname; for example, when not using Friedrich Engels's full name, say 'Engels' instead of 'Friedrich.' However, Vietnamese names are an exception and use the second (given) name. Mongolian names only have a patronymic or matronymic and then personal name with no surname, and Icelandic names have a given name and then patronymic. In both cases, the given name should be used.

References

Use our Citation template for books and scientific articles, and the Web citation template for material usually available online or periodicals, newspapers, etc. These options are available through Visual Editor.

Order of final headings

The end of a page must always follow this order in its headings:

See also [links to other internal pages]

Further reading [links to books or articles in the library]

External links [links to outside pages]

Notes

References

Library

It was decided that when importing library works, we will not remove sections from the source or edit sentences in other ways. However, it was decided that we are allowed to add a foreword of our own as well as our own footnotes (called annotations) like so:

Library work infobox

  • Books should all contain the Template:Library work infobox (call it with two curly brackets {{ }} ). The infobox should include at least the work's title, author, publication year and the source (either link to PDF or text or "X publisher edition" if taken from paper copy). It will automatically retitle the page according to the first two parameters. Ideally, the infobox should use as many parameters as possible.

Library foreword

  • We can add our own foreword to contextualize the text, explain why the reader should read it, explain that we've added our own footnotes but have not removed anything from the text.
  • Use the Template:Foreword and populate the parameters, it will create the heading itself as well as any necessary styling.
  • Remember that your foreword represents ProleWiki as a whole.

Library annotations

  • Add a "basic" citation (Ctrl+Shift+K), and put it in the ProleWiki group like this[ProleWiki 1]
  • Preferably add annotations at the end of a paragraph.
  • Use sparingly, only to add corrections or important context.
  • Editors without the trusted role should confirm their footnotes with the trusted editors before saving them on a page.
  • References list should be at the end of the chapter or the end of the text, as a subheading nested under the editor's references, and called "ProleWiki annotations." Example:

Notes (<-- subheading 1)

*editor's footnotes from original text

ProleWiki annotations (<-- subheading 2)

  1. Note 1

Acceptable edits to original text

Spelling variations of proper nouns

If a library work contains an outdated spelling or Romanization of a place name or personal name, add the modern spelling in brackets afterwards:

In December 1905 a Bolshevik Conference was held in Tammerfors [Tampere], Finland. (History of the Communist party of the Soviet Union)

Units of measurement

If a library work contains non-Metric units of measurement, add the Metric equivalent in brackets afterwards. For example:

It should be mentioned that in 1937 the collective farms alone (without the state farms) produced a marketable surplus of over 1,700,000,000 poods [28,000,000 tonnes] of grain, which was at least 400,000,000 poods [6,600,000 tonnes] more than the landlords, kulaks and peasants together marketed in 1913. (History of the Communist Party of the Soviet Union)

In this example, the pood is a traditional Slavic unit of weight equal to 16.38 kg.

See also