ProleWiki:Editorial guidelines: Difference between revisions

From ProleWiki, the proletarian encyclopedia
No edit summary
Tag: Visual edit
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
We have editorial conventions that help maintain a consistent style throughout the whole wiki. If you usually edit articles, it may be cool to once in a while discuss ideas in the [[ProleWiki talk:Editorial conventions|discussion page]] and check what has been decided.
{{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.


The best thing you can do before contributing is to see already made articles and check their format, how they're written, etc. In any case, this reference may also help.
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]].


== Articles ==
==Content pages==
We use American English on the reason of being a more popular spelling (more people in the world spell that way).
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 of articles, books, chapters ===
===Title===


==== Proper case approach ====
* 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>'''Socialism with Chinese <u>c</u>haracteristics'''


instead of  
* 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 former countries and states, 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)]].
*** If a country began and ended before the Common Era, use only in the second year: [[Roman Republic (509–27 BCE)]]. If a country begin before the Common Era and ended during it, use BCE for the first year and CE for the second: [[Han dynasty (202 BCE–220 CE)]].
* For organizations, use the full official name and do not abbreviate.
* 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.
** 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.


'''Socialism with Chinese <u>C</u>haracteristics'''</blockquote>This approach makes reading sometimes easier, i.e.:<blockquote>'''The Economic Basis of the Withering Away of the State'''
===Body===
<ol style="list-style-type:upper-roman">
<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">
<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>
<p style="font-size:85%">From ProleWiki, the proletarian encyclopedia</p>
'''Historical materialism''' broadly refers to applying the philosophy of dialectical materialism to the study of social life.
</blockquote>


vs.
==== Bluelinking and redlinking ====


'''The economic basis of the withering away of the state'''</blockquote>
* 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). <small>(note how the second mention of Marxist-Leninist is not linked in the example)</small><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.
</blockquote>


=== Body ===
* Blue links should also strictly be made in body text, never in headings. This is for readability reasons and coherence.
* 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.


==== Introduction ====
====Citations====
[[File:Editorial convention bold.png|center|thumb|When mentioning the subject of the article in the article body for the first time, use '''bold'''. This was adopted from Wikipedia's conventions, i.e.,]]


==== Content ====
* Avoid placing a citation after a space<blockquote class="toccolours">Jeff Bezos is a parasite.<sup>[1]</sup> ('''do''')<br>Jeff Bezos is a parasite. <sup>[1]</sup> ('''don't''')</blockquote>
Don't use external links in the article body. External links should be put in a "External links" section at the end of the article.


=== Referencing ===
* Avoid placing a citation before punctuation<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>
==== Cited works ====
For books:
<blockquote>Author (Year). ''Title in italics.'' Publisher. ISBN [number] (Library Genesis link)</blockquote>
Chapters inside books, if you wish to be more precise:
<blockquote>Author (Year). 'Chapter between single quotes' in ''Title in italics.'' Publisher. ISBN [number] (Library Genesis link)</blockquote>
Example:
<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>


For articles:
==== Naming conventions ====
<blockquote>Author (Year). ''Title in italics.'' City: Publisher. doi:[code] (Sci-Hub link)</blockquote>
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.
Example:
<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]]


<small>NOTE: publisher is optional. Library Genesis and Sci-Hub link only if available</small>
===References ===
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.


==== To avoid ====
=== Order of final headings ===
* References should not have a space before them:
The end of a page must always follow this order in its headings:<blockquote>See also [links to other internal pages]
<blockquote class="toccolours">Jeff Bezos is a parasite.<sup>[1]</sup> ('''do''')<br>Jeff Bezos is a parasite. <sup>[1]</sup> ('''don't''')</blockquote>


* References should not go before punctuations
Further reading [links to books or articles in the library]
<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>


=== External sources ===
External links [links to outside pages]
Avoid using external sources in the article body! To refer to external sources, link it in a header or as a reference at the bottom of the article, as [[Lemmygrad|seen in the Lemmygrad article]], for instance.


=== Linking ===
Notes
Links made to other articles should be made only when they are introduced in the article. There is no need to put the same links in the whole body of the article.


== Translations ==
References</blockquote>
please help


== Library works ==
==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:


=== Referencing ===
===Library work infobox===
The references inside a chapter in the book are put in a "Notes" section before the end of the chapter. See [[Library:The state and revolution|''The state and revolution'']] for reference.
*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.


Each chapter will have the reference group according to the chapter number. I.e.,
=== Library foreword ===


* For the first chapter of a book you would put "1" as reference group in visual editor or in source editor:
* 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.


<nowiki><ref group="1">etc., etc.</ref></nowiki>
=== Library annotations ===


* For the third chapter of a book you would put "3" as reference group in visual editor or in source editor:
* 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:


<nowiki><ref group="3">etc., etc.</ref></nowiki>
=== Notes (<-- subheading 1) ===
If the work is short or if it contains fewer than 1 reference per chapter, then you should put references at the bottom.
<nowiki>*</nowiki>editor's footnotes from original text
 
==== ProleWiki annotations (<-- subheading 2) ====
<references group="ProleWiki" />
 
=== Modernization of texts ===
 
==== 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 [[Bolsheviks|Bolshevik]] Conference was held in Tammerfors [Tampere], [[Grand Duchy of Finland (1809–1917)|Finland]]. ([[Library:History of the Communist Party of the Soviet Union|''History of the Communist party of the Soviet Union'']])</blockquote>However, if the same spelling is used multiple times, only add the modern spelling the first time and leave it unchanged the other times:<blockquote>After [[Roman Ungern-Sternberg|Ungern]]'s defeat, the [[Republic of China|Chinese]] general [[Zhang Zuolin|Chang Tso-lin]] [Zhang Zuolin] endeavoured, with the help of [[Empire of Japan (1868–1947)|Japanese]] [[Imperialism|imperialists]], to throttle the [[Mongolian People's Revolution|people's revolution]] in [[Bogd Khanate of Mongolia (1911–1924)|Mongolia]] and bring the latter under his control. On July 1, 1921, a meeting organized by Chang Tso-lin was held in Mukden which was attended by representatives of the [[Feudalism|feudal]] [[nobility]] of [[Inner Mongolia Autonomous Region|Inner]] and Outer Mongolia. At the meeting plans were discussed for seizing Outer Mongolia; Chang Tso-lin made active preparations for a march on Urga [Örgöö]. (''[[Library:History of the Mongolian People's Republic|History of the Mongolian People's Republic]]'')</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 [[Kolkhoz|collective farms]] alone (without the [[Sovkhoz|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 [[Landlord|landlords]], [[Kulak|kulaks]] and [[Peasantry|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]]
 
[[Category:Contribute to ProleWiki]]

Latest revision as of 15:49, 6 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 organizations, use the full official name and do not abbreviate.
  • 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

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

  • Blue links should also strictly be made in body text, never in headings. This is for readability reasons and coherence.
  • 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

  • Avoid placing a citation after a space

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

  • 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

Modernization of texts

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)

However, if the same spelling is used multiple times, only add the modern spelling the first time and leave it unchanged the other times:

After Ungern's defeat, the Chinese general Chang Tso-lin [Zhang Zuolin] endeavoured, with the help of Japanese imperialists, to throttle the people's revolution in Mongolia and bring the latter under his control. On July 1, 1921, a meeting organized by Chang Tso-lin was held in Mukden which was attended by representatives of the feudal nobility of Inner and Outer Mongolia. At the meeting plans were discussed for seizing Outer Mongolia; Chang Tso-lin made active preparations for a march on Urga [Örgöö]. (History of the Mongolian People's Republic)

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