CZ:Article mechanics: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>Larry Sanger
m (Text replacement - "CZ:Article Mechanics" to "CZ:Article mechanics")
 
(179 intermediate revisions by 37 users not shown)
Line 1: Line 1:
== Introductory material ==
<center><div class="usermessage plainlinks">'''This is a summary of  [[CZ:Article mechanics Complete|The complete document here]].'''</div></center>
{{TOC|right}}


=== Bold titles ===
''See also [[CZ:Content_Policy|content policy]].''


In most articles, we should '''bold''' the title of the article. For example:
[[Citizendium]] aims to build a body of [[CZ:Articles|articles]] that ''introduce'' their topics in an accessible, yet authoritative, way. An article is not a mere summary or list of information, but a connected piece of prose, meant to be read all the way through. Articles must be selective in what they present, but need not be ''brief''; they should say what they need to as clearly as possible, in a concise and interesting way.


:'''Philosophy,''' both the field and the concept, is notoriously hard to define. The question "What is philosophy?" is itself, famously, a vexing philosophical question. It is often observed that philosophers are unique in the extent to which they disagree about what their field even is.
==Opening section==
The opening section should ''always'' be introductory, so the heading "Introduction" is unnecessary. The first paragraph usually begins with a definition, and we '''bold''' the title of the article in the first sentence, e.g.: "'''Philosophy''' is an abstract, intellectual discourse..." The first paragraph should contain a concise and neutral answer to "Why is this topic important (or interesting)?" If the topic is a person, say what the person is best known for; if an event, summarize its impact; if a place, describe what makes it notable. The rest of the opening section should give the background needed for understanding the rest of the article. The opening section can be a ‘’summary’’ of the article, but a brief outline of the article structure may be better if the article is very long.


But on some pages this is unnecessary, particularly where it would produce strange or nonsensical results. Such pages include lists, as in [[list of snake scales]], or where the title of the article is an idiosyncratic phrase that does not name a single, particular item to be defined or described, such as [[potassium in nutrition and human health]].
== The article body ==
Generally, articles need a plan that lends coherence and flow and invites readers to keep reading. A task of editors is to help plan articles, and this may be discussed on the Talk page. Generally, major achievements of individuals should be presented before minor ones; the basic tenets of a theory before derivative ones; and earlier events before later ones.


=== The first sentence ===
=== Section titles ===
Section headings help both readers and authors, but too many can be ugly and distracting. A well-organized narrative is [http://pilot.citizendium.org/wiki?title=Biology&oldid=100047130 this "Biology" article].


What the first sentence of the article should look like depends on whether the article concerns a concept or, instead, a particular thing.
=== Standardized information ===
If there is to be an article about every species of snake, it is convenient to have a standard structure. When beginning an article, authors should check articles on closely related themes to see if a standard structure has already been established by others. ''Citizendium'' [[CZ:Workgroups|workgroups]] will ultimately settle on any such standard practices.


Generally, in articles about concepts, or where the word in the title has a definition, the first sentence in the article is a definition.  For example:
=== Citations ===
See [[Help:Citation style]]. We expect citations in about the same quantity as in academic encyclopedias. '''Citations are not usually needed for information that is common knowledge among experts.''' But the following categories of claims generally do need citation:
* direct quotations
* claims with unique sources (such as survey results, or the finding of a particular paper)
* implausible-sounding but well-established claims
* claims central to the article


:'''Dermatology''' is the specialty of medicine concerned with the [[skin]] and with the skin appendages ([[hair]], [[nail|nails]], [[sweat gland|sweat glands]], etc.).
Wherever possible, give an online link for any reference, at least to the abstract (via, for example, a PubMed reference.)


If, however, there is no agreed-upon definition, and particularly where the disagreement about the definition is an important aspect of the topic--one thinks of [[freedom]] or [[racism]]--it is preferable ''not'' to begin with a single (and controversial) definition.  In such cases, it is actually preferable to begin in some other way, even by describing the difficulty of or the controversy over the concept.  (See the "Philosophy" example above.)
Rather than use several references in one sentence, it may be better to include several sources in one citation.


In articles about particular things, such as persons, historical events, or publications, it is usually preferable to begin the article with a description of what the item in question is most notable for:
'''It is important to give full citation credit to imported illustrations, where for example these are imported from open-access journals.'''


:'''Princeton, New Jersey''' is located in Mercer County, New Jersey, United States, and is best known as the home, since 1756, of Princeton University.
== Definition ==
See [[CZ:Definitions]]. Every page should have a subpage/Definition that only contains a short sentence explaining the topic of the page:
* Maximum one sentence  (no more than 30 words/150 characters, ignoring formatting characters).
* Don't include the term defined in the definition itself.
* Start the text with a capital letter and end with a period. (Use a semicolon, if necessary, in between, but no period.)
This definition is mainly used on the /Related Pages subpage where
: <nowiki>  {{r|number}} </nowiki> and <nowiki>  {{r|no number}} </nowiki>
produce
: {{r|number}} and {{r|no number}}
If there is a main page, but no /Metadata page (e.g., if the page is a redirect),
the template shows the link in boldface.
A special case of this is a ''[[CZ:Lemma article|lemma article]]'', which is an article
that has a main page containing only the <nowiki>{{subpages}}</nowiki> template. In this case,
the /Definition is transcluded to the page:
: {{r|foo lemma}}
A definition intended for a lemma article may be longer than a "normal" definition. Lemma articles may have Related Articles, Bibliography and External Links subpages, which must not have the <nowiki>{{subpages}}</nowiki> template.  At any time, a lemma article may be converted to a regular article; at that point, part of a long definition usually will move to the main page.


:'''William Shakespeare''' (baptised April 26, 1564 – died April 23, 1616) was an English poet and playwright widely regarded as the greatest writer of the English language, as well as one of the greatest in Western literature, and the world's preeminent dramatist.
== Metadata ==
See [[CZ:Article structure#Metadata]]


=== Etymologies ===
Organizational and technical information related to a page is stored on a special template page Template:''ArticleName''/Metadata:
Title, title for alphabetization, workgroups, status, approval data, etc.
It also contains the workgroup categories.
(Please note that [[CZ:Categories|categories]] are only used for administrative purposes.)


Most etymologies of terms are not so interesting or important that they deserve more than cursory treatment.  So, usually they should be placed in parenthetical clarifications
== Subpages ==
Factual material, where there is no real narrative flow, may be best presented in [[CZ:Subpages|subpages]]. The standard subpages will always include:


:'''Physics''' (from the Greek ''physikos,'' nature) is the science of nature at its most fundamental form...
===Related articles subpage===
This connects each article with related articles and offers greater insight into the underlying conceptual structure of the encyclopedia. Related Articles subpages generally are organized into a few Parent Topics, which are more general topics within which the current article is located; Subtopics, which are aspects of the main topic worth separate discussion; and Related Topics are "close tangents" which take the discussion off in new directions. The article on [[World War I]] includes Parent Topics on War and [[Nationalism]], Subtopics include famous battles such as [[Gallipoli]] and the [[Somme]], and Related Articles include [[Trench warfare]] and [[Mustard gas]].


or [http://pilot.citizendium.org/wiki?title=Biology&oldid=100047130#_note-0 even in footnotes,] where the etymology is of interest, but is desired not to interrupt the flow of the article.
=== Bibliography subpage===
This is an annotated [[CZ:Bibliography|bibliography]]: books, articles and other material that are important and useful, clarifying why an item is listed ("one of the most commonly used texts in this field"; "the paper which originally defined the concept"). For example, historical topics may list and annotate the leading sources for information on a topic, and articles about authors may list their major works. If an item is available online, the annotation should provide the link. (Here are the [[CZ:Citation templates|citation templates]].) How to write annotations is discussed by the [http://www.loc.gov/nls/other/annotation/revised/creating%20an%20annotation%20(without%20title%20page).pdf Library of Congress publication ''Creating an Annotation''.]


But occasionally the etymology of a term is itself of such interest that it can be made a subject of its own sentence, paragraph, or even section:
Articles may also have a "Suggested reading" section at the end of the main article that presents 5-10 publications suitable for beginners, especially if they are on the web.


:The word [[morphology]] came into English in the mid 19th century from Greek words ''μορφή (morphi)'' meaning "shape or form" and ''λόγος (logos)'' meaning "speak". In English the suffix "-(o)logy" means "the study of". For ancient Greeks, study often involved a great deal of debate; and this is still true for scientists today.
=== External links subpage===


A lengthy etymology is called for particularly when discussion sheds some special light on other than merely linguistic facts.  A classic example can be found, again, in [[philosophy]].
''See [[CZ:External Links]]''


Authors are encouraged to follow one of the above conventions for reporting etymologies.
External links should be neutrally annotated.  Links to external websites should not be placed within articles but in footnotes.  Link words and phrases to ''Citizendium'' articles rather than external sources of information --even if we still lack an article on the subject. We have rules against self-promotion ([[CZ:Policy on Topic Informants|policy on topic informants]]), and contributors should not link to websites that they manage, unless it is very evident that the website is a leading ''and reliable'' source of information.


=== Definitions ===
=== Optional subpages ===
''See [[CZ:Subpages#Optional subpages|list of optional subpages]]


To learn how to write a good definition, you might consult the many good explanations found in introductory logic and critical thinking textbooks. The requirements we have will be approximately the same that you will find there.
Many other subpages may be included; the current list of subpages includes Works, Discography, Filmography, Catalogs, Timelines, Gallery (Images), Audio and Video pages, Computer Code, Tutorials, Student-level discussions, Signed Article, Function, Addendum, Debate Guide, Advanced and Recipes.
<br>There are also some ''[[CZ:Article-specific subpages|article-specific]]'' subpages (for certain topics) which are not yet fully acknowledged.
<br>Please note [[CZ:Categories|Categories]] are used for administrative purposes (workgroups, etc.) only.
Lists of topics are compiled on appropriate /Catalogs subpages.


Perhaps most general terms in the ''Citizendium'' have more or less agreed-upon definitions.  But there are many terms of which there is no agreed definition, and where the definition is in fact a central matter of dispute.  This is true of many abstract concepts in the humanities and social sciences, and sometimes in the hard sciences.  We must weigh two concerns: on the one hand, the desire of the user for a straightforward account of the topic; on the other hand, an unbiased article, i.e., one that does not violate our [[CZ:Neutrality Policy|Neutrality Policy]].
== Miscellaneous style guidelines ==
 
''See also [[CZ:Sage_advice_on_writing_CZ_articles|Sage advice on writing CZ articles]].
There are several acceptable ways to solve this problem:
* Provide a single vague definition, in plain terms, which does not engage the main topics of dispute.
* Provide a quick run-down of several main definitions.
* Explicitly discuss the difficulty of defining the term; provide examples.
 
It is rarely if ever acceptable, however, to begin an article with just one idiosyncratic definition when there are many importantly different definitions--particularly when our opening with that definition would imply an endorsement of the ''Citizendium'' by a particular controversial view.  If for whatever reason this were to be the only reasonable way to begin an article, one would have to qualify the definition.  One might say that it is so-and-so's definition, that we (the ''Citizendium'') are using the definition in order to give the reader a rough idea of the concept, but that there are many other ways of understanding the concept, and that we do not particularly favor this one.


=== The first paragraph ===
Craft articles for maximum readability. Many topics may be impossible for a non-specialist fully to understand, but if an advanced piece of text ''can'' be written to make it more accessible to nonspecialists, then it ''should'' be. Professionals are often accused of writing jargon that is decipherable only by people in their fields; our task is to "translate" the jargon into elegant prose.


The first paragraph of articles should typically (not always: see above) begin with either a definition or a description of that for which a particular thing is best known.  As to rest of that opening paragraph, typically, it should begin a narrative, and be written in an interesting and informative style.  It should not simply be a summary of facts stated within the main body of the article. It should attempt to describe a concept that ties together the entire article into a cohesive whole.
=== Grammar, spelling, punctuation, and usage===
Strunk and White's ''Elements of Style'' is useful; the first edition is available [http://www.bartleby.com/141/ here.] For American English, please consult ''The Chicago Manual of Style'' for matters of formatting, punctuation, etc. and Garner's ''Dictionary of American English Usage'' for issues of usage. For British English, consult Fowler's ''Modern English Usage''.


It should also encourage reader interest.
For usage of [[SI]] ("metric") units see the [http://www.physicstoday.org/guide/metric.html Physics Today] guide for metric practice.  


=== The introductory section ===
For physics oriented articles consult chapters III and IV of [http://forms.aps.org/author/styleguide.pdf The American Physical Society Style Guide]. (Pdf).


Articles begin with an introduction.  The introductory section of an article (or, what comes before the first section marker) should ''at least'' give background necessary for purposes of understanding the rest of the article.  What else an introduction might accomplish depends on the article.  Generally, what ''sort'' of introduction is needed depends entirely on the subject matter and the approach that the article takes. For example, if the article concerns some abstruse concept, the entire introductory section might be devoted to clarifying the concept.  If the article itself is primarily a narrative, the introduction would do "stage setting" for the narrative, such as introducing characters and preparing readers for key events.  If the article concerns a controversy, then the introduction might characterize the controversy in a general way, introduce key players, define positions, or do other such stage-setting.
=== Lists ===
Main articles should not be a list of topics (even if annotated). The appropriate place for such material is either the Related Articles subpage or a Catalogs subpage. Such lists are not collected using [[CZ:Categories|categories]] (Categories are only used for administrative purposes).


It is acceptable for the introduction to be a summary of the topic itself, that is, to sum up the information found in the article.  This is not necessarily the best use of the space, however.  Authors are asked to consider whether a summary of the information found in the article clarifies matters for the user particularly; often, the answer will be "no."
=== Write lively prose, not "encyclopedese" ===
Writing an encyclopedia brings out a tendency in some writers to make prose dull--perhaps  the influence of boring encyclopedia articles we read as children.  But we can, and should, give our prose personality. Many writers today have taken William Strunk's pithy injunction, [http://www.bartleby.com/141/strunk5.html#13 "Omit needless words,"] to heart.  Tightening up flabby verbiage is one of the most ''needful'' improvements we can make, '''but''' we must not denature our prose entirely: we want our writing to be readable, not encyclopedese.


In fact, however, a brief outline of the article structure--as distinguished from a summary of the information contained in the article--is ''preferable'' when the article is particularly long. If the introduction ''contains'' such an outline, the summary should come at the end of the introduction.
Another common stylistic rule would have us use simple Anglo-Saxon words rather than hifalutin, impressive-sounding words, '''but''' this does not mean that we should prefer a merely adequate word to a really apt word just because the apt word is a bit more obscure. Choose the familiar word rather than the obscure word, but the precise word rather than the loose word.


== Article structure ==
=== Link copiously, but relevantly ===
One strength of a wiki-based encyclopedia is the ease with which articles can link to other articles.  Links permit serendipitous discoveries, and ''Citizendium'' encourages copious interlinking. But [[pronoun|it]] is [[possibility|possible]] to take [[demonstrative pronoun|this]] [[advice]] to an [[absurdism|absurd]] [[extremism|extreme]]--linking so many words that many ''inappropriate'' links are created, that distract rather than help. Remember that two consecutive links (of the same color) will run together as if they were one; it may be better to reword so the links are separated by a non-link word.


=== Suggested components ===
A general rule is:
:'''If our target audience would find that the linked article illuminates the present article, then we should link to it.'''


=== Narrative coherence and flow ===
It is important to add links to articles that do not yet exist -these help us see what articles are most needed: see [[Special:Wantedpages|Wanted Pages]] (linked on the left under toolbox > Special pages).
 
=== Prioritization of article sections ===
 
== Grammar, spelling, punctuation, and usage ==
 
== Miscellaneous style guidelines ==


=== No long quotations ===
Link only the first use of a word or phrase, not every use--unless the word is ''particularly'' relevant to the point. Thus, the article about [[Abraham Lincoln]] might mention (and link to) the [[Emancipation Proclamation]] in its opening section, and also in the section about the Proclamation itself.


As a general rule, we should not use quotations that are longer than one sentence, and we should not use ''many'' quotations in any one article. The purpose of a quotation is typically to illustrate or support some point. Quotations are, therefore, texts that ''support'' the main text, which the ''Citizendium'' writes.
=== Quotations ===
In general, avoid quotations longer than one sentence, and do not use ''many'' quotations in any one article. Quotations should not be used to “make an argument”; an argument is made by logic and reason, not by authority, and if a quote is used to support an argument by showing that important people agree with the point, then this is a misuse. However if notable people are identified with a particular argument, then it would be reasonable to quote them. For example, [[Richard Dawkins]] is a vocal proponent of [[evolution|Darwinism]]—it should not be presented as an argument for Darwinism that its proponents include Richard Dawkins, but as he has contributed extensively to the debate, to quote him would be a reasonable way of illustrating a section that describes his arguments.  


There are at least two main reasons for this policy against many and long quotations.
Valid uses of quotes include (in biographical sections) to illustrate a person’s views; (in literature articles) to exemplify an author’s style; and (in many articles) to add colour and interest to an article. Be aware that, in some articles, using quotes can introduce a bias. Choose them with care, and consider redressing any bias by annotations, or by balancing quotes from other viewpoints.


First, such quotations prevent collaboration on the substance of the text (quotations are uneditable).  It is inherently biased to have an extended quote that speaks ''for'' the ''Citizendium,'' since in that case the ''Citizendium'' is made to endorse a whole series of points that are only that source's idiosyncratic views. Second, the practice of adding a long quotation cannot be generalized.  If we have a long quotation that supports one point, why should we not have long quotations that support ''every'' point? There is a vast universe of books and other potentially supporting verbiage. We can find long quotations for ''everything,'' if we wanted to. Therefore, unless there is some particularly good reason to use a quotation beyond one sentence, don't do it; summarize.
=== Conversions ===
There is one central [[Template:Convert|conversion template]], {{tl|Convert}}. This can be used to convert between two units of measurement. To use it, write it out as you would speak the conversion. For example "Convert 10 inches to centimetres" would be written <nowiki>"{{Convert|10|in|cm}}"</nowiki> and would display as {{Convert|10|in|cm}}.


The exceptions will, perhaps, be in cases where texts themselves are the ''primary'' subject of an article. Even in this case, extended quotations are to be used sparingly and only with excellent justification.
More powerful features for individual conversions are found on individual templates.
Each has additional parameters that determine such things as abbreviation, spelling, ranges, two dimensional, three dimensional, and whether or not to wiki-link the units of measurement.
An example would be {{tl|In to Cm}}. These should only be used if {{tl|Convert}} does not support the feature you need.


=== Craft articles for maximum readability ===
A full list is at [[:Category:Conversion templates]]


Craft articles for maximum readability.  Many topics are inherently complex and impossible for a nonspecialist fully to understand.  Nevertheless, our task is to write at the university level.  Therefore, if a difficult or advanced piece of text ''can'' be written in a way to make it more accessible to educated nonspecialists, then it ''should'' be.


Scientists, business people, lawyers, and academics are famous for writing mumbo-jumbo that is decipherable only by people in their fields.  But, as this is a ''general'' encyclopedia, not a single topic encyclopedia, is our obligation to "translate" the jargon of a specialized field, so far as is possible, into elegant English prose.
<center>'''This is a policy summary.  [[CZ:Article mechanics Complete|The complete document is here]].'''</center>


Even if an article concerns some very abstruse topic, the details of which no one but specialists can be expected to understand, ''if'' there is a way to introduce some fundamental aspect of the topic that is accessible to nonspecialists, then the article should begin with such an introduction.  For example, the details of [[quantum mechanics]] cannot be expected to be understandable by anyone but physicists, but there are certain experiments and analogies that can be used to introduce the topic: if such explanatory devices, accessible to the layperson, are ready to hand, then we should make use of them.
{{Content Policy}}
[[Category:Policies]]

Latest revision as of 16:02, 5 March 2024

This is a summary of The complete document here.

See also content policy.

Citizendium aims to build a body of articles that introduce their topics in an accessible, yet authoritative, way. An article is not a mere summary or list of information, but a connected piece of prose, meant to be read all the way through. Articles must be selective in what they present, but need not be brief; they should say what they need to as clearly as possible, in a concise and interesting way.

Opening section

The opening section should always be introductory, so the heading "Introduction" is unnecessary. The first paragraph usually begins with a definition, and we bold the title of the article in the first sentence, e.g.: "Philosophy is an abstract, intellectual discourse..." The first paragraph should contain a concise and neutral answer to "Why is this topic important (or interesting)?" If the topic is a person, say what the person is best known for; if an event, summarize its impact; if a place, describe what makes it notable. The rest of the opening section should give the background needed for understanding the rest of the article. The opening section can be a ‘’summary’’ of the article, but a brief outline of the article structure may be better if the article is very long.

The article body

Generally, articles need a plan that lends coherence and flow and invites readers to keep reading. A task of editors is to help plan articles, and this may be discussed on the Talk page. Generally, major achievements of individuals should be presented before minor ones; the basic tenets of a theory before derivative ones; and earlier events before later ones.

Section titles

Section headings help both readers and authors, but too many can be ugly and distracting. A well-organized narrative is this "Biology" article.

Standardized information

If there is to be an article about every species of snake, it is convenient to have a standard structure. When beginning an article, authors should check articles on closely related themes to see if a standard structure has already been established by others. Citizendium workgroups will ultimately settle on any such standard practices.

Citations

See Help:Citation style. We expect citations in about the same quantity as in academic encyclopedias. Citations are not usually needed for information that is common knowledge among experts. But the following categories of claims generally do need citation:

  • direct quotations
  • claims with unique sources (such as survey results, or the finding of a particular paper)
  • implausible-sounding but well-established claims
  • claims central to the article

Wherever possible, give an online link for any reference, at least to the abstract (via, for example, a PubMed reference.)

Rather than use several references in one sentence, it may be better to include several sources in one citation.

It is important to give full citation credit to imported illustrations, where for example these are imported from open-access journals.

Definition

See CZ:Definitions. Every page should have a subpage/Definition that only contains a short sentence explaining the topic of the page:

  • Maximum one sentence (no more than 30 words/150 characters, ignoring formatting characters).
  • Don't include the term defined in the definition itself.
  • Start the text with a capital letter and end with a period. (Use a semicolon, if necessary, in between, but no period.)

This definition is mainly used on the /Related Pages subpage where

{{r|number}} and {{r|no number}}

produce

If there is a main page, but no /Metadata page (e.g., if the page is a redirect), the template shows the link in boldface. A special case of this is a lemma article, which is an article that has a main page containing only the {{subpages}} template. In this case, the /Definition is transcluded to the page:

  • Foo lemma [r]: This example of a lemma has only a definition page and an article page with the subpages template. The article transcludes the text from the definition page. The link to the article, when using the R template is shown in black to indicate it has no more content that the definition which can already be seen. [e]

A definition intended for a lemma article may be longer than a "normal" definition. Lemma articles may have Related Articles, Bibliography and External Links subpages, which must not have the {{subpages}} template. At any time, a lemma article may be converted to a regular article; at that point, part of a long definition usually will move to the main page.

Metadata

See CZ:Article structure#Metadata

Organizational and technical information related to a page is stored on a special template page Template:ArticleName/Metadata: Title, title for alphabetization, workgroups, status, approval data, etc. It also contains the workgroup categories. (Please note that categories are only used for administrative purposes.)

Subpages

Factual material, where there is no real narrative flow, may be best presented in subpages. The standard subpages will always include:

Related articles subpage

This connects each article with related articles and offers greater insight into the underlying conceptual structure of the encyclopedia. Related Articles subpages generally are organized into a few Parent Topics, which are more general topics within which the current article is located; Subtopics, which are aspects of the main topic worth separate discussion; and Related Topics are "close tangents" which take the discussion off in new directions. The article on World War I includes Parent Topics on War and Nationalism, Subtopics include famous battles such as Gallipoli and the Somme, and Related Articles include Trench warfare and Mustard gas.

Bibliography subpage

This is an annotated bibliography: books, articles and other material that are important and useful, clarifying why an item is listed ("one of the most commonly used texts in this field"; "the paper which originally defined the concept"). For example, historical topics may list and annotate the leading sources for information on a topic, and articles about authors may list their major works. If an item is available online, the annotation should provide the link. (Here are the citation templates.) How to write annotations is discussed by the Library of Congress publication Creating an Annotation.

Articles may also have a "Suggested reading" section at the end of the main article that presents 5-10 publications suitable for beginners, especially if they are on the web.

External links subpage

See CZ:External Links

External links should be neutrally annotated. Links to external websites should not be placed within articles but in footnotes. Link words and phrases to Citizendium articles rather than external sources of information --even if we still lack an article on the subject. We have rules against self-promotion (policy on topic informants), and contributors should not link to websites that they manage, unless it is very evident that the website is a leading and reliable source of information.

Optional subpages

See list of optional subpages

Many other subpages may be included; the current list of subpages includes Works, Discography, Filmography, Catalogs, Timelines, Gallery (Images), Audio and Video pages, Computer Code, Tutorials, Student-level discussions, Signed Article, Function, Addendum, Debate Guide, Advanced and Recipes.
There are also some article-specific subpages (for certain topics) which are not yet fully acknowledged.
Please note Categories are used for administrative purposes (workgroups, etc.) only. Lists of topics are compiled on appropriate /Catalogs subpages.

Miscellaneous style guidelines

See also Sage advice on writing CZ articles.

Craft articles for maximum readability. Many topics may be impossible for a non-specialist fully to understand, but if an advanced piece of text can be written to make it more accessible to nonspecialists, then it should be. Professionals are often accused of writing jargon that is decipherable only by people in their fields; our task is to "translate" the jargon into elegant prose.

Grammar, spelling, punctuation, and usage

Strunk and White's Elements of Style is useful; the first edition is available here. For American English, please consult The Chicago Manual of Style for matters of formatting, punctuation, etc. and Garner's Dictionary of American English Usage for issues of usage. For British English, consult Fowler's Modern English Usage.

For usage of SI ("metric") units see the Physics Today guide for metric practice.

For physics oriented articles consult chapters III and IV of The American Physical Society Style Guide. (Pdf).

Lists

Main articles should not be a list of topics (even if annotated). The appropriate place for such material is either the Related Articles subpage or a Catalogs subpage. Such lists are not collected using categories (Categories are only used for administrative purposes).

Write lively prose, not "encyclopedese"

Writing an encyclopedia brings out a tendency in some writers to make prose dull--perhaps the influence of boring encyclopedia articles we read as children. But we can, and should, give our prose personality. Many writers today have taken William Strunk's pithy injunction, "Omit needless words," to heart. Tightening up flabby verbiage is one of the most needful improvements we can make, but we must not denature our prose entirely: we want our writing to be readable, not encyclopedese.

Another common stylistic rule would have us use simple Anglo-Saxon words rather than hifalutin, impressive-sounding words, but this does not mean that we should prefer a merely adequate word to a really apt word just because the apt word is a bit more obscure. Choose the familiar word rather than the obscure word, but the precise word rather than the loose word.

Link copiously, but relevantly

One strength of a wiki-based encyclopedia is the ease with which articles can link to other articles. Links permit serendipitous discoveries, and Citizendium encourages copious interlinking. But it is possible to take this advice to an absurd extreme--linking so many words that many inappropriate links are created, that distract rather than help. Remember that two consecutive links (of the same color) will run together as if they were one; it may be better to reword so the links are separated by a non-link word.

A general rule is:

If our target audience would find that the linked article illuminates the present article, then we should link to it.

It is important to add links to articles that do not yet exist -these help us see what articles are most needed: see Wanted Pages (linked on the left under toolbox > Special pages).

Link only the first use of a word or phrase, not every use--unless the word is particularly relevant to the point. Thus, the article about Abraham Lincoln might mention (and link to) the Emancipation Proclamation in its opening section, and also in the section about the Proclamation itself.

Quotations

In general, avoid quotations longer than one sentence, and do not use many quotations in any one article. Quotations should not be used to “make an argument”; an argument is made by logic and reason, not by authority, and if a quote is used to support an argument by showing that important people agree with the point, then this is a misuse. However if notable people are identified with a particular argument, then it would be reasonable to quote them. For example, Richard Dawkins is a vocal proponent of Darwinism—it should not be presented as an argument for Darwinism that its proponents include Richard Dawkins, but as he has contributed extensively to the debate, to quote him would be a reasonable way of illustrating a section that describes his arguments.

Valid uses of quotes include (in biographical sections) to illustrate a person’s views; (in literature articles) to exemplify an author’s style; and (in many articles) to add colour and interest to an article. Be aware that, in some articles, using quotes can introduce a bias. Choose them with care, and consider redressing any bias by annotations, or by balancing quotes from other viewpoints.

Conversions

There is one central conversion template, {{Convert}}. This can be used to convert between two units of measurement. To use it, write it out as you would speak the conversion. For example "Convert 10 inches to centimetres" would be written "{{Convert|10|in|cm}}" and would display as 10 in (25.4 cm).

More powerful features for individual conversions are found on individual templates. Each has additional parameters that determine such things as abbreviation, spelling, ranges, two dimensional, three dimensional, and whether or not to wiki-link the units of measurement. An example would be {{In to Cm}}. These should only be used if {{Convert}} does not support the feature you need.

A full list is at Category:Conversion templates


This is a policy summary. The complete document is here.


Citizendium Content Policy
Approval Standards | Article Mechanics | Subpages | Importing material from other sources | Citable articles

|width=10% align=center style="background:#F5F5F5"|  |}

Retrieved from "https://citizendium.org/wiki/index.php?title=CZ:Article_mechanics&oldid=924892"