Difference between revisions of "Help:Style"

From XFamily - Children of God
(style snippets)
 
m (→‎Templates: listed {{caution child abuse}})
 
(49 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
The following are ''only'' suggestions and I welcome changes and suggestions. [[User:Thorwald|Thorwald]] 19:43, 5 Feb 2005 (CST)
+
=Introduction to Style Guide=
  
−
==Multi-licensed into the public domain==
+
==Basics==
  
−
May I suggest each editor add the following to their profile? It is suggested at Wikipedia to let everyone know that the information we provide is in the public domain. [[User:Thorwald|Thorwald]] 12:03, 11 Mar 2005 (CST)
+
===Attribution===
  
−
<table cellspacing="1" cellpadding="1" style="background: #F1F1DE; border: 1px solid #CC9; padding: 5px;">
+
The summary field for edits should be used to attribute contributions whenever possible.
−
<tr style="text-align: center;">
+
 
−
<td style="background: #CCC;">'''Multi-licensed into the public domain'''</td>
+
==Categorization==
−
</tr>
+
 
−
<tr>
+
{{Template:Placeholder}}
−
<td colspan="3">
 
−
''I agree to multi-license my eligible text contributions, unless otherwise stated, under the [http://www.gnu.org/copyleft/fdl.html GFDL] and into the [http://en.wikipedia.org/wiki/Public_domain Public domain]. Please be aware that other contributors might not do the same, so if you want to use my contributions in the public domain, please check the [http://en.wikipedia.org/wiki/Wikipedia:Multi-licensing multi-licensing guide].''
 
−
</td>
 
−
</tr>
 
−
</table>
 
  
 
==Disclaimer==
 
==Disclaimer==
  
−
Please add the following disclaimer to the top of every aricle that contains any potentially offensive material.
+
Pages displaying content from [[The Family]] should use a disclaimer. Please see the [[Help:Style#Templates|template section]] below for the approptiate template to use.
  
−
<pre>
+
==Templates==
−
<div style="margin: 10px; padding: 5px; border: 2px solid red;">
+
  see: [[:Category:Templates]] for complete listing
−
'''DISCLAIMER:''' [...]
+
Templates exist Under "Templates:Foo". They are invoked in articles using the following syntax: <nowiki>{{foo}}</nowiki> which then displays the content of the template in the article at the position of the tag. Editors should document any templates they create below:
−
</div>
 
−
</pre>
 
  
−
Replace [...] with "Publications by The Family are archived here for educational purposes. The content is occasionally offensive or illegal and we collect them here to document their existence and wording but do not condone the points of view or activities. The text below is presented as close to the original as possible. Original spelling, grammar, and style have been preserved where possible."
+
*[[Template:AgeGroups]] - <nowiki>{{AgeGroups}}</nowiki> - For use in articles describing age structure in The Family.
 +
*[[Template:LeadershipStructure]] - <nowiki>{{LeadershipStructure}}</nowiki> - For use in articles describing the leadership structure in The Family.
 +
*[[Template:InfoboxPerson]] - <nowiki>{{InfoboxPerson}}</nowiki> - For use in articles specific to an individual.
 +
*[[Template:Caution]] - <nowiki>{{caution}}</nowiki> - For articles which contain explicit text or images.
 +
*[[Template:Caution child abuse]] - <nowiki>{{caution child abuse}}</nowiki> - For articles which contain explicit descriptions of child abuse.
 +
*[[Template:Construction]] - <nowiki>{{construction}}</nowiki> - For use in articles which do not need outside content contributions.
 +
*[[Template:Satire]] - <nowiki>{{satire}}</nowiki> - For use in articles within [[:Category:Satire]].
 +
*[[Template:Stub]] - <nowiki>{{stub}}</nowiki> - For use in incomplete articles for which we are accepting outside content contributions.
 +
*[[Template:Sectionstub]] - <nowiki>{{sectionstub}}</nowiki> - For use in incomplete article sections for which we are accepting outside content contributions.
 +
*[[Template:Placeholder]] - <nowiki>{{placeholder}}</nowiki> - For use in "placeholder" sections within an article.
 +
*[[Template:Disclaimer-family]] - <nowiki>{{disclaimer-family}}</nowiki> - For use in articles from The Family which may contain offensive content.
 +
*[[Template:Disclaimer-article]] - <nowiki>{{disclaimer-article}}</nowiki> - For use in articles reproduced herein "as is".
 +
*[[Template:Disclaimer-article-inaccurate]] - <nowiki>{{disclaimer-article-inaccurate}}</nowiki> - For use in articles reproduced herein "as is" when known to contain inaccuracies.
 +
*[[Template:Privacy-edited]] - <nowiki>{{privacy-edited}}</nowiki> - For use in articles where a name has been removed.
 +
*[[Template:Purged-Document]] - <nowiki>{{purged-document}}</nowiki> - For use in articles where original material has been purged by The Family International.
 +
*[[Template:Public-Domain]]  - <nowiki>{{Public-Domain}}</nowiki> - For use in editor's personal profiles should they wish to multi-license their contributions.
 +
*[[Template:FairUse]] - <nowiki>{{FairUse}}</nowiki> - For use where fair use rights are invoked.
 +
*[[Template:Pseudonym]] - <nowiki>{{Pseudonym|Name}}</nowiki> - For use in name disambiguation pages. Invoke with the name as the template parameter using a pipe character after the template name followed by the name being disambiguated.
 +
*[[Template:External-author]] - <nowiki>{{external-author}}</nowiki> - For use in delineating texts by external authors that are reproduced on xFamily.org without the collaborative editing process of our regular articles.
 +
*[[Template:Rough-translation-disclaimer]] - <nowiki>{{rough-translation-disclaimer}}</nowiki> - For use in articles which contain preliminary and non-professional translations.
 +
*[[Template:Ocr-disclaimer]] - <nowiki>{{ocr-disclaimer}}</nowiki> - For use in articles which contain text obtained using optical character recognition technology.
 +
*[[Template:Citation needed]] - <nowiki>{{citation needed}}</nowiki> - For use in articles which contain text needing a source.
  
−
The result should look like this:
+
==Code Snippets==
−
<div style="margin: 10px; padding: 5px; border: 2px solid red;">
 
−
'''DISCLAIMER:''' Publications by The Family are archived here for educational purposes. The content is occasionally offensive or illegal and we collect them here to document their existence and wording but do not condone the points of view or activities. The text below is presented as close to the original as possible. Original spelling, grammar, and style have been preserved where possible.
 
−
</div>
 
  
−
==Documents==
+
===Quoting===
  
 
If you include excerpts from or the entire contents of documents, please place them within a <code>blockquote</code>. If there are quotes within the document, please ''also'' place them within a <code>blockquote</code>.
 
If you include excerpts from or the entire contents of documents, please place them within a <code>blockquote</code>. If there are quotes within the document, please ''also'' place them within a <code>blockquote</code>.
Line 41: Line 52:
 
<pre>
 
<pre>
 
<div style="padding: 1em; margin: 10px; border: 2px dotted green;">
 
<div style="padding: 1em; margin: 10px; border: 2px dotted green;">
−
==The Devil Hates Sex==
+
<small><font color=green>1</font></small> The Devil hates...
−
''--By [[Father David]], 20 May 1980 (DFO#999)''
+
</div>
 +
</pre>
  
 +
This would result in a border like this:
  
 +
<div style="padding: 1em; margin: 10px; border: 2px dotted green;">
 
<small><font color=green>1</font></small> The Devil hates...
 
<small><font color=green>1</font></small> The Devil hates...
 
</div>
 
</div>
−
</pre>
 
  
−
The result should look like this:
+
==Icons==
−
<div style="padding: 1em; margin: 10px; border: 2px dotted green;">
+
 
 +
Use of the following icons is optional.
 +
* [[Image:Icon_star.gif|Featured]] - <nowiki>[[Image:Icon_star.gif|Featured]]</nowiki> - To highlight a certain link on a page that is worthwhile to the reader. Use sparingly to avoid dillution.
 +
* [[Image:Icon_video.gif|Video]] - <nowiki>[[Image:Icon_video.gif|Video]]</nowiki>
 +
* [[Image:Icon_audio.gif|Audio]] - <nowiki>[[Image:Icon_audio.gif|Audio]]</nowiki>
 +
* [[Image:Icon_music.gif|Music]] - <nowiki>[[Image:Icon_music.gif|Music]]</nowiki>
 +
* [[Image:Icon pdf.gif|PDF]] - <nowiki>[[Image:Icon_pdf.gif|PDF]]</nowiki>
 +
* [[Image:Icon_zip.gif|ZIP]] - <nowiki>[[Image:Icon_zip.gif|ZIP]]</nowiki>
 +
 
 +
==Article Talk Pages==
 +
 
 +
Please follow these guidelines when using the article talk pages ("discussion" tab).
 +
 
 +
Threads are demarcated by nested lists. For example
 +
 
 +
*This is the first part of a thread. --[[User:Craven de Kere|Craven de Kere]] 14:13, 10 Jun 2005 (CDT)
 +
**This is the response. --[[User:Craven de Kere|Craven de Kere]] 14:13, 10 Jun 2005 (CDT)
 +
***This is yet another response. --[[User:Craven de Kere|Craven de Kere]] 14:13, 10 Jun 2005 (CDT)
 +
 
 +
Comments should be signed. Using the following code automatically inserts a signature: <nowiki>--~~~~</nowiki>
 +
 
 +
New threads should be placed above the older ones on an article talk page. In some cases, the [http://xchildrenofgod.xfamily.org/ forum] is a more appropriate place for discussion.
  
−
==The Devil Hates Sex==
+
==Tools==
−
''--By [[Father David]], 20 May 1980 (DFO#999)''
 
  
 +
===Bible Online===
  
−
<small><font color=green>1</font></small> The Devil hates...
+
see: [[Template:Bible]] or [http://bible.xfamily.org http://bible.xfamily.org] for newer capabilities.
−
</div>
 
  
−
==Watermarking photographs==
+
When linking to Bible verses use the following script. It will be updated to use a functional online reference resource should the current resource cease to function. Using this script allows us to easily update all Bible references in such a scenario.
−
The following is ''only'' a concept of a possible watermark.
 
−
[[Image:Watermark-test.jpg|left|thumb|Watermark concept]]
 
−
<br clear="all" />
 
  
−
==Linking to Bible Verses==
+
The script is located at: http://www.xfamily.org/xscripts/bible/
  
−
Use the following script:
+
You should add GET variables to the URL to redirect to a particular passage. See the example below.
  
 
http://www.xfamily.org/xscripts/bible/?book=Matthew&chapter=9&verse=17
 
http://www.xfamily.org/xscripts/bible/?book=Matthew&chapter=9&verse=17
  
−
The book, chapter and verse variables should be set in the url. Ranges are allowed.
+
Ranges are allowed. Please see the example below:
 +
 
 +
http://www.xfamily.org/xscripts/bible/?book=Matthew&chapter=9&verse=17-20
 +
 
 +
When a space exists in one of the variables you should use "%20" (no quotation marks) to represent the space. This is necessary with books like I John. Please see the example below:
 +
 
 +
http://www.xfamily.org/xscripts/bible/?book=I%20John&chapter=1&verse=1
 +
 
 +
===xFamily Forum===
 +
 
 +
When linking to specific portions of the [http://xchildrenofgod.xfamily.org/ xFamily Forum] use the following script. It will be updated to use correct links should the current forum link structure change. Using this script allows us to easily update all forum references in such a scenario.
 +
 
 +
The script is located at: http://www.xfamily.org/xscripts/forum/
 +
 
 +
You should add GET variables to the URL to redirect to a particular passage. See the examples below.
 +
 
 +
{| style="border: 1px solid #CCC;"
 +
|-
 +
| '''Topics'''
 +
| http://www.xfamily.org/xscripts/forum/?topic=1
 +
|- style="background-color: #EFEFEF;"
 +
| '''Posts'''
 +
| http://www.xfamily.org/xscripts/forum/?post=1
 +
|-
 +
| '''Forums'''
 +
| http://www.xfamily.org/xscripts/forum/?forum=1
 +
|- style="background-color: #EFEFEF;"
 +
| '''Users'''
 +
| http://www.xfamily.org/xscripts/forum/?user=1
 +
|-
 +
| '''Categories'''
 +
| http://www.xfamily.org/xscripts/forum/?category=1
 +
|- style="background-color: #EFEFEF;"
 +
| '''Search'''
 +
| http://www.xfamily.org/xscripts/forum/?search=Berg
 +
 
 +
When a space exists in your forum search query, use "%20" (no quotation marks) to represent the space. See the example below:<br>
 +
http://www.xfamily.org/xscripts/forum/?search=David%20Berg
 +
|}
 +
 
 +
===Sandbox===
  
−
==New "Categories" Concept==
+
The sandbox is a place to experiment with this wiki. You can find it here: [[Sandbox]]
−
<!-- THIS IS A SIDEBAR. Skip to the comment "END OF SIDEBAR 2" to continue editing the text of the article. -->
 
−
<div style="float: left; border: 1px solid #aaa; border-collapse: collapse; width: 33%; margin-left: 1em; margin-bottom: 1em; color: black; background-color: #F8FCFF;">
 
−
<div style="color: white; background-color: #2985CC; text-align: center; padding: .25em; font-weight: bold; margin: 0;">Categories</div>
 
−
* '''foo1'''
 
−
** bar1
 
−
* '''foo2'''
 
−
** bar2
 
−
** bar2
 
−
* '''foo3'''
 
−
* '''foo4'''
 
−
* '''foo5'''
 
−
<div style="font-size: 91%; padding: 1em;">
 
−
<!-- END OF SIDEBAR 2 -->
 

Latest revision as of 16:45, 14 October 2006

Introduction to Style Guide

Basics

Attribution

The summary field for edits should be used to attribute contributions whenever possible.

Categorization

This section is a placeholder. This means it is incomplete and in need of further elaboration.

We will update this as time permits.

Disclaimer

Pages displaying content from The Family should use a disclaimer. Please see the template section below for the approptiate template to use.

Templates

 see: Category:Templates for complete listing

Templates exist Under "Templates:Foo". They are invoked in articles using the following syntax: {{foo}} which then displays the content of the template in the article at the position of the tag. Editors should document any templates they create below:

  • Template:AgeGroups - {{AgeGroups}} - For use in articles describing age structure in The Family.
  • Template:LeadershipStructure - {{LeadershipStructure}} - For use in articles describing the leadership structure in The Family.
  • Template:InfoboxPerson - {{InfoboxPerson}} - For use in articles specific to an individual.
  • Template:Caution - {{caution}} - For articles which contain explicit text or images.
  • Template:Caution child abuse - {{caution child abuse}} - For articles which contain explicit descriptions of child abuse.
  • Template:Construction - {{construction}} - For use in articles which do not need outside content contributions.
  • Template:Satire - {{satire}} - For use in articles within Category:Satire.
  • Template:Stub - {{stub}} - For use in incomplete articles for which we are accepting outside content contributions.
  • Template:Sectionstub - {{sectionstub}} - For use in incomplete article sections for which we are accepting outside content contributions.
  • Template:Placeholder - {{placeholder}} - For use in "placeholder" sections within an article.
  • Template:Disclaimer-family - {{disclaimer-family}} - For use in articles from The Family which may contain offensive content.
  • Template:Disclaimer-article - {{disclaimer-article}} - For use in articles reproduced herein "as is".
  • Template:Disclaimer-article-inaccurate - {{disclaimer-article-inaccurate}} - For use in articles reproduced herein "as is" when known to contain inaccuracies.
  • Template:Privacy-edited - {{privacy-edited}} - For use in articles where a name has been removed.
  • Template:Purged-Document - {{purged-document}} - For use in articles where original material has been purged by The Family International.
  • Template:Public-Domain - {{Public-Domain}} - For use in editor's personal profiles should they wish to multi-license their contributions.
  • Template:FairUse - {{FairUse}} - For use where fair use rights are invoked.
  • Template:Pseudonym - {{Pseudonym|Name}} - For use in name disambiguation pages. Invoke with the name as the template parameter using a pipe character after the template name followed by the name being disambiguated.
  • Template:External-author - {{external-author}} - For use in delineating texts by external authors that are reproduced on xFamily.org without the collaborative editing process of our regular articles.
  • Template:Rough-translation-disclaimer - {{rough-translation-disclaimer}} - For use in articles which contain preliminary and non-professional translations.
  • Template:Ocr-disclaimer - {{ocr-disclaimer}} - For use in articles which contain text obtained using optical character recognition technology.
  • Template:Citation needed - {{citation needed}} - For use in articles which contain text needing a source.

Code Snippets

Quoting

If you include excerpts from or the entire contents of documents, please place them within a blockquote. If there are quotes within the document, please also place them within a blockquote.

The following is an example of how this is done: 

<div style="padding: 1em; margin: 10px; border: 2px dotted green;">
<small><font color=green>1</font></small> The Devil hates...
</div>

This would result in a border like this:

1 The Devil hates...

Icons

Use of the following icons is optional.

  • Featured - [[Image:Icon_star.gif|Featured]] - To highlight a certain link on a page that is worthwhile to the reader. Use sparingly to avoid dillution.
  • Video - [[Image:Icon_video.gif|Video]]
  • Audio - [[Image:Icon_audio.gif|Audio]]
  • Music - [[Image:Icon_music.gif|Music]]
  • PDF - [[Image:Icon_pdf.gif|PDF]]
  • ZIP - [[Image:Icon_zip.gif|ZIP]]

Article Talk Pages

Please follow these guidelines when using the article talk pages ("discussion" tab).

Threads are demarcated by nested lists. For example

  • This is the first part of a thread. --Craven de Kere 14:13, 10 Jun 2005 (CDT)

Comments should be signed. Using the following code automatically inserts a signature: --~~~~

New threads should be placed above the older ones on an article talk page. In some cases, the forum is a more appropriate place for discussion.

Tools

Bible Online

see: Template:Bible or http://bible.xfamily.org for newer capabilities.

When linking to Bible verses use the following script. It will be updated to use a functional online reference resource should the current resource cease to function. Using this script allows us to easily update all Bible references in such a scenario.

The script is located at: http://www.xfamily.org/xscripts/bible/

You should add GET variables to the URL to redirect to a particular passage. See the example below.

http://www.xfamily.org/xscripts/bible/?book=Matthew&chapter=9&verse=17

Ranges are allowed. Please see the example below:

http://www.xfamily.org/xscripts/bible/?book=Matthew&chapter=9&verse=17-20

When a space exists in one of the variables you should use "%20" (no quotation marks) to represent the space. This is necessary with books like I John. Please see the example below:

http://www.xfamily.org/xscripts/bible/?book=I%20John&chapter=1&verse=1

xFamily Forum

When linking to specific portions of the xFamily Forum use the following script. It will be updated to use correct links should the current forum link structure change. Using this script allows us to easily update all forum references in such a scenario.

The script is located at: http://www.xfamily.org/xscripts/forum/

You should add GET variables to the URL to redirect to a particular passage. See the examples below.

Topics http://www.xfamily.org/xscripts/forum/?topic=1
Posts http://www.xfamily.org/xscripts/forum/?post=1
Forums http://www.xfamily.org/xscripts/forum/?forum=1
Users http://www.xfamily.org/xscripts/forum/?user=1
Categories http://www.xfamily.org/xscripts/forum/?category=1
Search http://www.xfamily.org/xscripts/forum/?search=Berg

When a space exists in your forum search query, use "%20" (no quotation marks) to represent the space. See the example below:
http://www.xfamily.org/xscripts/forum/?search=David%20Berg

Sandbox

The sandbox is a place to experiment with this wiki. You can find it here: Sandbox

Retrieved from "https://www.xfamily.org/index.php?title=Help:Style&oldid=18850"