ProleWiki:Editorial guidelines: Difference between revisions

From ProleWiki, the proletarian encyclopedia
No edit summary
Tag: Visual edit: Switched
(→‎Library: clarified and rewrote the opening paragraph for this section a bit. It should flow more naturally now and cover all cases)
Tag: Visual edit
 
(46 intermediate revisions by 3 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 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==
===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 (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>
<li>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]].
<li>For persons, 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.
<li>Be as specific as needed. For instance, the ''Russian revolution'' can mean both the [[Russian revolution of 1905|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.
</ol>


=== Title ===
===Body===
The title of the article should be always be capitalized (the MediaWiki engine already does that), and the rest of the article title should be as lowercase as possible, i.e.,<blockquote>Socialism with Chinese characteristics
<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>
<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>


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


"Socialism with Chinese Characteristics."</blockquote>This approach makes reading sometimes easier.
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 and put external sources there.


=== Body ===
====Citations====
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.,
<ol style="list-style-type:upper-roman" start="1">
<blockquote>
<li>Avoid placing a citation after a space</ol>
Title of the article: Historical materialism. </br>
<blockquote class="toccolours">Jeff Bezos is a parasite.<sup>[1]</sup> ('''do''')<br>Jeff Bezos is a parasite. <sup>[1]</sup> ('''don't''')</blockquote>
Body of article: "'''Historical materialism''' broadly refers to applying (...)"
 
</blockquote>
<ol style="list-style-type:upper-roman" start="2">
<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>
 
===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.
 
=== Order of sections (headings) ===
The end of a page must always follow this order in its headings:<blockquote>See Also [links to other internal pages]
 
Further Reading [links to books or articles]
 
External Links [links to outside pages]
 
References</blockquote>
 
==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 footnotes (called annotations) like so:


=== Cited works ===
===Library work infobox===
There will be many cases where it's not always clear when to lowercase and when to uppercase certain expressions. Cited works in other media usually have all their words capitalized, but we use a lowercase approach with italics when citing work titles, i.e.,<blockquote>''Ludwig Feuerbach and the end of classical German philosophy''
*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.


instead of
=== Library foreword ===


"Ludwig Feuerbach And The End of Classical German Philosophy"</blockquote>In this case, the capitalized words are either proper nouns or nationalities, and the italics are used to show this is a cited work.
* 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.


When we cite works written by famous marxists, we put their short name and title of work, i.e.,<blockquote>Engels: ''Ludwig Feuerbach and the end of classical German philosophy''
=== Library annotations ===


Fanon: ''The wretched of the Earth''
* Add a "basic" citation (Ctrl+Shift+K), and put it in the '''ProleWiki''' group like so: <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 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:


Marx: ''Critique of the Gotha program'' </blockquote>
=== Notes (<-- subheading 1) ===
<nowiki>*</nowiki>editor's footnotes


=== External sources ===
==== ProleWiki annotations (<-- subheading 2) ====
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 here]].
<references group="ProleWiki" />
[[Category:Contribute to ProleWiki]]

Latest revision as of 19:10, 30 October 2023

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

Title

  1. Use preferably 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)

  2. 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.
  3. For persons, 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.
  4. Be as specific as needed. For instance, the Russian revolution can mean both the 1905 Russian bourgeois revolution and the 1917 Russian socialist revolution. In this case, a title which already disambiguates this difference is ideal.

Body

  1. 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.
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 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)

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 sections (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]

External Links [links to outside pages]

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 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 so: [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

ProleWiki annotations (<-- subheading 2)

  1. Note 1