Content Style Guide - Substance: Difference between revisions

Latest revision as of 18:40, 20 August 2020

Writing styles establish conventions that enable constructive collaboration and improved communication across articles on the site. This page documents the PsychonautWiki "house style" for published content.

General principles

Accessibility: Content should always be written in a way that is both scientifically accurate while at the same time understandable by the layperson. One should always assume the worst case: that the readers are using a mobile phone to look up a substance they just encountered while at a house-party, festival or rave and need access to all the vital facts to prevent injury or overdose. It is important to note that, according to analytics, 2/3rd's of PsychonautWiki users are mobile users, so content should be optimized for mobile use.
Neutrality: Remove all of your personal views on the topic when writing an article. Extensively consult dictionaries, thesauri, Google, Wikipedia, and similar PW substance pages to get an idea of how information should be formatted and presented. Resist all urges to glorify or promote substance use or psychonaut culture and stick with the facts that are obtainable from the scientific and anecdotal literature.
Word economy: Do your best not to use any unnecessary space -- always try to aim for clarity and succinctness. Avoid including unnecessarily long sentences, paragraphs, and digressions. Focus on the vital information, and then re-read it to see if you can word it in a way that saves space or makes it easier to digest.
Readability: Readability is the ease with which a reader can understand a written text. Due to the nature of the modern attention span, the way the text is structured is vital. This mostly comes in the form of simple, concise sentences and properly spaced paragraphs. Nothing gets people to disengage faster than a wall of text in poetic or abstract language, especially while inebriated.

A typical paragraph should be roughly four simple sentences in length. Use three if they are more complex sentences with long dependent clauses (parts of a sentence that cannot stand alone). It is acceptable sometimes to use shorter paragraphs if they express a self-contained thought.
Minimize the use of dependent clauses or chains of independent clauses in a single sentence. Err on the side of sentence breaks, even if it may sound a little stuttery.

Example: Instead of using "In various studies, X has been shown to cause Y effect in some users, and this effect has been linked to various psychiatric conditions, as well as other negative effects on bodily organs." use "Various studies have shown that X causes Y effect in some users. This effect has been linked to various psychiatric conditions as well as other adverse effects on bodily organs."

Tone: The tone for all articles on this wiki should be encyclopedic: formal, impersonal, and objective. For inspiration, please refer to encyclopedias like Encyclopedia Britannica, Encyclopedia.com, and to a lesser extent, Wikipedia. PsychonautWiki's LSD page provides a good example of proper house style and tone because it is one of the most highly developed pages.

Writing style

Avoid loanwords (words in a language that are taken from another language without translation e.g. zeitgeist).
Avoid passive speech; be direct.
Avoid slang, vernacular and idioms.
Avoid addressing the reader at any point. Use the third person tense.
Avoid judgement, opinion and unfounded interpretation.
Avoid reports of self-experience outside of experience-reports.
Avoid using parenthetical clauses. Use separate sentences instead.

Prefer using as few words as possible to make a point.
Prefer marked, uncited recitation of original content: "..., reports suggest, ...,"^{[citation needed]} "..., has been reported,"^{[citation needed]} "Based on reports, it is likely that, ..., "^{[citation needed]}
Prefer short alternatives to long words.
Prefer simple English: not all of our users are native speakers.
Prefer concise and approachable speech.

Grammatics

Capital letters

Capitalization of article titles and section headers should include the first letter of the first word being a capital letter, but it should otherwise follow the normal English rules of capitalization. For example, a section title should be "External links" instead of "External Links."
Unless occurring at the beginning of a sentence, the names for substances should not be capitalized. Names in substance boxes should be capitalized.
The first letter of generic names of pharmaceutical drugs should be lower case while brand names must be capitalized. For example, Ambien is capitalized while zolpidem is not.

Word choices

Select the bolded words when faced with a choice between the two options.

semisynthetic vs. semi-synthetic
naturally occurring vs. naturally-occuring
substance vs. drug (unless it is from a reference that explicitly uses the word 'drug')

Markup

Please become acquainted with the Wiki formatting markup.

Linking

Linking is usually limited to the first occurrence of the word or phrase in each article. This is because using too many wiki-links makes articles difficult to read. Adding multiple links for the same term may be acceptable in long articles in which linked instances of the term are very far apart.

Internal links

An internal link refers to a link to within a page that directs to another page found on the wiki. For example adding two brackets around a term like "serotonergic psychedelic" (serotonergic psychedelic) will link to the PsychonautWiki page on that entry.

Please make sure to keep internal links whole, so that does not include dangling letters or phrases.

Example: Instead of [[serotonergic psychedelic]]s USE [[serotonergic psychedelic|serotonergic psychedelics]]

Edit summaries

Every edit must include a concise, descriptive summary of what was changed and the reasoning or evidence behind it (if applicable). The exception to this is if it is marked as a "Grammatics" change, which we define as minor changes to grammar, formatting (e.g., adding a bracket or removing a line of space), or changes in word and phrasing that does not alter the original meaning of the text. We reserve the right to revert changes immediately and without comment to any change that lacks a commentary summary.

Please respect the edit summary spaces by not vandalizing them, using them to inject personal commentary or as a means of inviting community discussion. If one wishes to start a discussion about the change or article itself, they are welcome to use the page's "Talk" section, which can be accessed by clicking the tab labeled "Discussion" near the top left corner of the page.

Formatting conventions

Introduction template

Option one should be the default formatting for substances (one sentence). However, for substances with multiple effects of note that result in long sentences, please resort to the two sentence structure shown below.

X (also known as Y, and Z) is a (naturally occuring / blank) (insert psychoactive class) substance of the (insert chemical class) class.

Examples:

3-MeO-PCP (also known as 3-MeO-PCP, and 3-MeO) is a novel dissociative substance of the arylcyclohexylamine class.

Basic pharmacology/classification info

X is a member of the 3T-D family of substances, which include substances like 3T-P, 3T-O, and 3T-H. It is believed to produce its effects via dopamine reuptake inhibition, although this has yet to be scientifically confirmed.

Brief history

The compound was first synthesized in 1979 to investigate the structure-activity relationship of DZT derivatives. The activity of XXX in humans was not described until 1999 when a chemist using the pseudonym John Q. Beagle wrote that XXX was qualitatively similar to YYY with comparable potency.[5]

Unique/relevant aspects

Like other substances of its class, particularly DAF and XCA, it primarily [induces vs. produces] a state referred to as "mega fucked up," albeit the extent to which this occurs is highly dose-dependent and variable in effect. (Description of distinguishing properties compared to other substances?) Its most common routes of administration include oral, sublingual or nasal administration. (Remark on common RoAs if relevant)

Modern relevance

(In modern times vs. Today) XXX is rarely sold on the streets and almost exclusively distributed as a gray area research chemical by online vendors, where it is commonly used for recreational and entheogenic purposes.

Warning and HR disclaimer (esp. if RC)

Due to its potent X and Y effects, reported habit-forming properties as well as unknown toxicity profile, it is strongly recommended that one use proper harm reduction practices if choosing to use this substance.

Flag template types

Flags (or tags) are templates that can be appended to text to signify a need for verification, revision, or other purposes. The most common kind is the missing citation flag or "cite flag" that appears in the form of [citation needed] wherever {{citation needed}} is added in the raw text for an article.

The various kinds of flags available for use are listed below:

Flag type	Purpose
{{citation needed}}	Statement is missing citation
{{clarify}}	Statement needs clarification
{{opinion}}	Statement is an opinion
{{overly specific}}	Statement is overly specific or graphic
{{imperative}}	Statement uses imperative speech

@@ Line 1: / Line 1: @@
-First is what we agreed to last time (which I can totally assent to). Nevertheless, please look these alternatives over and reconsider merging the sentences as that might allow more possibilities. Just a bunch of variants. Lemme know what you think :)
+Writing styles establish conventions that enable constructive collaboration and improved communication across articles on the site. This page documents the [[PsychonautWiki]] "house style" for published content.
+== General principles ==
+*'''Accessibility:''' Content should always be written in a way that is both scientifically accurate while at the same time understandable by the layperson. One should always assume the worst case: that the readers are using a mobile phone to look up a substance they just encountered while at a house-party, festival or rave and need access to all the vital facts to prevent injury or overdose. It is important to note that, according to analytics, '''2/3rd's of PsychonautWiki users are mobile users,''' so content should be optimized for mobile use.
+*'''Neutrality''': Remove all of your personal views on the topic when writing an article. Extensively consult dictionaries, thesauri, Google, Wikipedia, and similar PW substance pages to get an idea of how information should be formatted and presented. Resist all urges to glorify or promote substance use or psychonaut culture and stick with the facts that are obtainable from the scientific and anecdotal literature.
+*'''Word economy''': Do your best not to use any unnecessary space -- always try to aim for clarity and succinctness. Avoid including unnecessarily long sentences, paragraphs, and digressions. Focus on the vital information, and then re-read it to see if you can word it in a way that saves space or makes it easier to digest.
+* '''Readability''': Readability is the ease with which a reader can understand a written text. Due to the nature of the modern attention span, the way the text is structured is vital. This mostly comes in the form of simple, concise sentences and properly spaced paragraphs. Nothing gets people to disengage faster than a wall of text in poetic or abstract language, especially while inebriated.
+#A typical paragraph should be roughly four simple sentences in length. Use three if they are more complex sentences with long dependent clauses (parts of a sentence that cannot stand alone). It is acceptable sometimes to use shorter paragraphs if they express a self-contained thought.
+#Minimize the use of dependent clauses or chains of independent clauses in a single sentence. Err on the side of sentence breaks, even if it may sound a little stuttery.
+::'''Example:''' Instead of using "In various studies, X has been shown to cause Y effect in some users, and this effect has been linked to various psychiatric conditions, as well as other negative effects on bodily organs." '''use''' "Various studies have shown that X causes Y effect in some users. This effect has been linked to various psychiatric conditions as well as other adverse effects on bodily organs."
+*'''Tone''': The tone for all articles on this wiki should be encyclopedic: formal, impersonal, and objective. For inspiration, please refer to encyclopedias like [https://www.britannica.com/ Encyclopedia Britannica], [https://www.encyclopedia.com/ Encyclopedia.com], and to a lesser extent, [http://www.wikipedia.org Wikipedia]. PsychonautWiki's [[LSD]] page provides a good example of proper house style and tone because it is one of the most highly developed pages.
-# '''Phencyclidine''' (also known as X, Y, and Z) is a synthetic substance of the arylcyclyohexylamine chemical class that is known to produce dissociating and stimulating effects when [[Routes of administration|administered]]."
+==Writing style==
-# '''Phencyclidine''' (also known as X, Y, and Z) is a synthetic [[psychoactive class:dissociative]] substance of the arylcyclyohexylamine chemical class. In addition to its principal role as a dissociative, it can also produce prominent stimulating effects when [[Routes of administration|administered]]."
+* '''''Avoid''''' loanwords (words in a language that are taken from another language without translation e.g. ''zeitgeist'').
-# '''Phencyclidine''' (also known as X, Y, and Z) is a synthetic [[psychoactive class:dissociative]] of the arylcyclyohexylamine chemical class. In addition to producing the effects typical of a dissociative anesthetic, it can also produce prominent stimulating effects when [[Routes of administration|administered]]
+* '''''Avoid''''' passive speech; be direct.
-# '''Psilocin''' (also known as X, Y, and Z) is a synthetic dissociative of the tryptamine chemical class that produces psychedelic effects when [[Routes of administration|administered]]."
+* '''''Avoid''''' slang, vernacular and idioms.
-# '''Lysergic acid diethylamide''' (also known as LSD, LSD-25, Lucy, and Acid) is a semi-synthetic [[psychoactive class:psychedelic]] of the [[chemical class:lysergamide]] chemical class that produces psychedelic effects when [[Routes of administration|administered]].
+* '''''Avoid''''' addressing the reader at any point. Use the third person tense.
-# '''Lysergic acid diethylamide''' (also known as LSD, LSD-25, Lucy, and Acid) is a semi-synthetic [[hallucinogenic]] substance of the [[chemical class:lysergamide]] chemical class that produces psychedelic effects when [[Routes of administration|administered]].
+* '''''Avoid''''' judgement, opinion and unfounded interpretation.
-# '''Lysergic acid diethylamide''' (also known as LSD, LSD-25, Lucy, and Acid) is a semi-synthetic [[hallucinogen]] of the [[chemical class:lysergamide]] chemical class that produces psychedelic effects when [[Routes of administration|administered]].
+* '''''Avoid''''' reports of self-experience outside of experience-reports.
-# '''Lysergic acid diethylamide''' (also known as LSD, LSD-25, Lucy, and Acid) is a (prevalent/major/popular?) semi-synthetic [[hallucinogen]] of the [[chemical class:lysergamide]] chemical class. It produces psychedelic effects when [[Routes of administration|administered]].
+* '''''Avoid''''' using parenthetical clauses. Use separate sentences instead.
-# '''Lysergic acid diethylamide''' (also known as LSD, LSD-25, Lucy, and Acid) is a semi-synthetic [[psychoactive class::psychedelic]] of the [[chemical class::lysergamide]] chemical class that produces archetypal psychedelic effects when [[Routes of administration|administered]], which is typically dosed orally or sublingually. (change "It produces" to "It is known to produce?")
-# Lysergic acid diethylamide (also known as LSD, LSD-25, Lucy, and Acid) is a semi-synthetic [[psychoactive class::psychedelic]] of the [[chemical class::lysergamide]] chemical class. It produces archetypal psychedelic effects when [[Routes of administration|administered]]. (change "It produces" to "It is known to produce?")
-# '''N-Ethylhexedrone''' (commonly known as Hexen or NEH) is a novel synthetic [[psychoactive class::stimulant]] belonging to the substituted [[chemical class::cathinone]] chemical class. It produces classical stimulant effects that is believed to be caused by its activity as an NDRI (norepinephrine-dopamine reuptake inhibitor), although this has yet to be scientifically validated.
-# '''N-Ethylhexedrone''' (commonly known as Hexen or NEH) is a novel synthetic [[psychoactive class::stimulant]] belonging to the substituted [[chemical class::cathinone]] chemical class that produces classical stimulant effects that is believed to be caused by its activity as an NDRI (norepinephrine-dopamine reuptake inhibitor), although this has yet to be scientifically validated.
-# '''3-Methoxyphencyclidine''' (commonly known as '''3-MeO-PCP''' or '''3-MeO''') is a novel synthetic [[Psychoactive class::dissociative]] of the [[Chemical class::arylcyclohexylamine]] chemical class. Like its closely related analogs [[PCP]], [[PCE]] and [[3-MeO-PCE]] it is known to produce potent [[dissociative]] and [[stimulant]] effects.
-# '''3-Methoxyphencyclidine''' (commonly known as '''3-MeO-PCP''' or '''3-MeO''') is a novel synthetic [[Psychoactive class::dissociative]] of the [[Chemical class::arylcyclohexylamine]] chemical class that produces potent [[dissociating]] and [[stimulating]] effects.
-=Generic Template for Substance Page Intros=
+* '''''Prefer''''' using as few words as possible to make a point.
+* '''''Prefer''''' marked, uncited recitation of original content: "''..., reports suggest, ...'',"{{citation needed}} "''..., has been reported'',"{{citation needed}} "Based on reports, it is likely that, ..., "{{citation needed}}
+* '''''Prefer''''' short alternatives to long words.
+* '''''Prefer''''' simple English''': not all of our users are native speakers.
+* '''''Prefer''''' concise and approachable speech.
-XXX (''[also vs. commonly]'' known as YYY or ZZZ) is a ''[naturally occurring vs. synthetic vs. semisynthetic]'' hallucinogenic '''(include this last part generally?)''' ''[insert psychoactive class]'' of the ''[insert chemical class]'' '''(of what though? should we specify further? if not generally relevant, any exceptions? What about family?)'''. Like its ''[closely vs. ??? vs. blank]'' related analogs XYZ, ABC and FUQ it is ''[descriptor of popularity, like widely, or blank?]'' ''[known]'' for ''[its vs. producing vs. ability to produce]'' potent '''(necessary?)''' anesthetic, hallucinogenic and stimulant effects. '''(Basic description and what it is known to do, or used for)'''
+==Grammatics==
+===Capital letters===
+*Capitalization of article titles and section headers should include the first letter of the first word being a capital letter, but it should otherwise follow the normal English rules of capitalization. For example, a section title should be "External links" instead of "External Links."
+*Unless occurring at the beginning of a sentence, the names for substances should not be capitalized. Names in substance boxes should be capitalized.
+*The first letter of generic names of pharmaceutical drugs should be lower case while brand names must be capitalized. For example, [[Ambien]] is capitalized while [[zolpidem]] is not.
-The compound was first synthesized in 1979 to investigate the structure-activity relationship of DZT derivatives. The activity of XXX in humans was not described until 1999 when a chemist using the pseudonym John Q. Beagle wrote that XXX was qualitatively similar to XX with comparable potency.[5] '''(History tidbit here, should these be standard if available?)'''
+=== Word choices ===
+''Select the bolded words when faced with a choice between the two options.''
-Like other substances of its class, particularly DAF and XCA, it primarily ''[induces vs. produces]'' a state referred to as "dissociative anesthesia", albeit the extent to which this occurs is highly dose-dependent and variable in effect.[citation needed] '''(Description of distinguishing properties compared to other substances?)''' Its most common routes of administration include oral, sublingual or nasal administration, although plugging, vaporization and IM/IV injection are also ''[possible albeit rare vs. have been observed, albeit rarely]'' and is associated with vastly increased harm potential. '''(Do we need to include available RoAs, just the common ones? Criteria? If we say it can be IVed do we discourage it directly or do as I did there)'''\\''']
+#'''semisynthetic''' vs. semi-synthetic
-[
+#'''naturally occurring''' vs. naturally-occuring
-'
+#'''substance''' vs. drug (unless it is from a reference that explicitly uses the word 'drug')
-'
+== Markup ==
+Please become acquainted with the [https://www.mediawiki.org/wiki/Help:Formatting Wiki formatting markup].
+===Linking===
+Linking is usually limited to the first occurrence of the word or phrase in each article. This is because using too many wiki-links makes articles difficult to read. Adding multiple links for the same term may be acceptable in long articles in which linked instances of the term are very far apart.
-''[In modern times vs. Today?]'', ''[XXX vs. it?]'' is rarely sold on the streets and almost exclusively obtained as a gray area research chemical through the use of online vendors, where it is commonly used as a recreational substance and, more ''[rarely and controversially]]'' '''(WC?)''', as an entheogen. '''(I like this as the standard closer, I think. Contains info on where it is obtained/used and what it is used for. Now how to word the last bit? All our substances are used recreationally, I think this only matters in this case? I guess there are cases of potentiators and such)'''
+===Internal links===
+An internal link refers to a link to within a page that directs to another page found on the wiki. For example adding two brackets around a term like "serotonergic psychedelic" ([[serotonergic psychedelic]]) will link to the PsychonautWiki page on that entry.
+Please make sure to '''keep internal links whole''', so that does not include dangling letters or phrases.
-==Chemistry==
+'''Example:''' Instead of <nowiki>[[serotonergic psychedelic]]s</nowiki> '''USE''' <nowiki>[[serotonergic psychedelic|serotonergic psychedelics]]</nowiki>
-==Pharmacology==
-==Subjective effects==
+==Edit summaries==
-==Toxicity and harm potential==
+Every edit must include a concise, descriptive summary of what was changed and the reasoning or evidence behind it (if applicable). The exception to this is if it is marked as a "Grammatics" change, which we define as minor changes to grammar, formatting (e.g., adding a bracket or removing a line of space), or changes in word and phrasing that does not alter the original meaning of the text. '''We reserve the right to revert changes immediately and without comment to any change that lacks a commentary summary.'''
-==Legal issues==
-==See also==
+Please respect the edit summary spaces by not vandalizing them, using them to inject personal commentary or as a means of inviting community discussion. If one wishes to start a discussion about the change or article itself, they are welcome to use the page's "Talk" section, which can be accessed by clicking the tab labeled "Discussion" near the top left corner of the page.
-==External links==
-==References==
+[[File:DiscussionTabExample.png|thumb|center|200px]]
-[[Category:Articles in talk page]]
+== Formatting conventions ==
+{{Main|Template:Substance Breakdown}}
+===Introduction template===
+'''Option one should be the default formatting for substances (one sentence). However, for substances with multiple effects of note that result in long sentences, please resort to the two sentence structure shown below.'''
+# '''X''' (also known as '''Y''', and '''Z''') is a (naturally occuring / blank) (insert psychoactive class) substance of the (insert chemical class) class.
+''Examples:''
+# '''3-MeO-PCP''' (also known as '''3-MeO-PCP''', and '''3-MeO''') is a novel [[psychoactive class::dissociative]] substance of the [[chemical class::arylcyclohexylamine]] class.
+===Basic pharmacology/classification info===
+#X is a member of the 3T-D family of substances, which include substances like 3T-P, 3T-O, and 3T-H. It is believed to produce its effects via dopamine reuptake inhibition, although this has yet to be scientifically confirmed.
+====Brief history====
+The compound was first synthesized in 1979 to investigate the structure-activity relationship of DZT derivatives. The activity of XXX in humans was not described until 1999 when a chemist using the pseudonym John Q. Beagle wrote that XXX was qualitatively similar to YYY with comparable potency.[5]
+====Unique/relevant aspects====
+Like other substances of its class, particularly DAF and XCA, it primarily ''[induces vs. produces]'' a state referred to as "mega fucked up," albeit the extent to which this occurs is highly dose-dependent and variable in effect. '''(Description of distinguishing properties compared to other substances?)''' Its most common routes of administration include oral, sublingual or nasal administration. '''(Remark on common RoAs if relevant)'''
+====Modern relevance====
+(In modern times vs. Today) XXX is rarely sold on the streets and almost exclusively distributed as a gray area research chemical by online vendors, where it is commonly used for recreational and entheogenic purposes.
+====Warning and HR disclaimer (esp. if RC) ====
+Due to its potent X and Y effects, reported habit-forming properties as well as unknown toxicity profile, it is strongly recommended that one use proper harm reduction practices if choosing to use this substance.
+== Flag template types ==
+Flags (or tags) are templates that can be appended to text to signify a need for verification, revision, or other purposes. The most common kind is the missing citation flag or "cite flag" that appears in the form of [citation needed] wherever <nowiki>{{citation needed}}</nowiki> is added in the raw text for an article.
+The various kinds of flags available for use are listed below:
+{|
+|-
+|
+{| class="wikitable"
+|-
+|-
+| '''Flag type''' || '''Purpose'''
+|-
+| <nowiki>{{citation needed}}</nowiki> || Statement is missing citation
+|-
+| <nowiki>{{clarify}}</nowiki>|| Statement needs clarification
+|-
+| <nowiki>{{opinion}}</nowiki> || Statement is an opinion
+|-
+| <nowiki>{{overly specific}}</nowiki> || Statement is overly specific or graphic
+|-
+| <nowiki>{{imperative}}</nowiki> || Statement uses imperative speech
+|}
+ ||
+|}
+[[Category:Content development]]

Content Style Guide - Substance: Difference between revisions

Latest revision as of 18:40, 20 August 2020

Contents

General principles

Writing style

Grammatics

Capital letters

Word choices

Markup

Linking

Internal links

Edit summaries

Formatting conventions

Introduction template

Basic pharmacology/classification info

Brief history

Unique/relevant aspects

Modern relevance

Warning and HR disclaimer (esp. if RC)

Flag template types

Navigation menu

Content Style Guide - Substance: Difference between revisions

Latest revision as of 18:40, 20 August 2020

General principles

Writing style

Grammatics

Capital letters

Word choices

Markup

Linking

Internal links

Edit summaries

Formatting conventions

Introduction template

Basic pharmacology/classification info

Brief history

Unique/relevant aspects

Modern relevance

Warning and HR disclaimer (esp. if RC)

Flag template types

Navigation menu

Search