Difference between revisions of "Help:Editing policies"

From SNIC Documentation
Jump to: navigation, search
(Undo revision 2821 by Joel Hedlund (NSC) (talk))
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This page contains information on how one should edit this wiki, eg: best practices, protocols, templates and the like.
 
This page contains information on how one should edit this wiki, eg: best practices, protocols, templates and the like.
  
These pages are a highly recommended read for new editors:
+
These pages are a highly recommended read:
# '''[[Help:Recommendations for editors]]'''
+
; [[Help:Recommendations for editors|Recommendations for editors]]
#: How to configure your account and to make sure your information gets displayed correctly.
+
: How to configure your account and to make sure your information gets displayed correctly.
# '''[[Help:Naming protocol]]'''
+
; [[Help:Tutorial|Oh God how does any of this work (Tutorial)]]
#: How to choose and spell names, terms, titles and the like.
+
: Quickly get up to speed with adding content. Has a nifty [[Help:Tutorial#Self-education|Self-education]] section that helps you discover exactly how things work around here.
# '''[[Help:Categories and properties]]'''
+
; [[Help:Content policy|Content policy]]
#: What they are, how they are used, and how to create new ones.
+
: What goes onto the wiki and what does not.
 
+
; [[Help:Naming protocol|Naming protocol]]
== Semantic mediawiki extension ==
+
: How to choose and spell names, terms, titles and the like.
The snicdocs wiki uses the [http://semantic-mediawiki.org semantic mediawiki] extension, which enables nifty things like dynamic generation of lists, tables and mashups based on tagged data in ordinary wiki pages. The annotation is unobtrusive, e.g:
+
; [[Help:Creating pages|Creating pages]]
 
+
: Helpful guides to creating pages. Contains nifty stuff with templates and examples that will reduce the amount of work you'll have to do.
: I am competent with <nowiki>[[expertise::Python]]</nowiki>.
+
; [[:Category:Example page|Example pages]]
 
+
: Your first stop for creating pages.
to note that this page (or rather the person described by this page) is competent in Python. The search/generate syntax is equally straightforward
+
; [[Help:Categories and properties|Categories and properties]]
 
+
: What they are, how they are used, and how to create new ones.
: <nowiki>{{#ask: [[Category:Software]] [[Category:Bioinformatics]] |?centre }}</nowiki>
+
; [[Help:Editing|Editing help]]
 
+
: Help with syntax, formatting and other practicalities.
However, we must not let nomenclature run rampant and diverge (see: the problem with the semantic web). See [[#Naming protocol|naming protocol]] below.
 
  
 
=== Notice ===
 
=== Notice ===
In case the examples appear in red, or if you see similar broken links with double colons in them in other places on the wiki, '''''do not edit the links'''''. They appear because you have happened to come across the pages before we have managed to install the semantic mediawiki extension properly on our production server. This problem should disappear very shortly, and if it persists beyond your definition of shortly, it may help to edit the page, do nothing, and click save, to prod mediawiki to regenerate the links. If nothing works, please notify [[User:Joel Hedlund (NSC)]].
+
This site has a lot of dynamically generated content, making heavy use of templates and the [http://semantic-mediawiki.org semantic mediawiki] extension. If anything looks broken or incorrect, please use the corresponding talk page to notify the person responsible. If all else fails, please notify [[User_talk:Joel Hedlund (NSC)]].
 
 
== Creating pages ==
 
;Ensure that you have [[#Set up your watch lists and notifications|set up your watch preferences and notifications]] correctly.
 
:Watch all pages that you create. Unwatched pages rot and we do not want that.
 
;Look at the [[:Category:Example page|example pages]]
 
:These are in the proper layout and use all the nifty templates for getting all the required information right. Chances are that much of the tedious work has already been done for you.
 
;Put some deep thought into the choice of page title.
 
:This is a wiki, so it matters a lot. See the relevant [[:Category:Example page|example pages]] for more details. Read the [[#Titles, headings and names|naming policies for titles, headings and names]] so you get it right.
 
;Create the talk page
 
:Also called the Discussion page. As this wiki is not open for unauthenticated editing other than through the talk pages, these are our primary form of input from the general public.
 
 
 
== Page examples, designs and templates ==
 
The examples and designs are all here:
 
:[[:Category:Example page]]
 
along with motivation on why you should not call them <s>templates</s> (because mediawiki has called dibs on that term).
 
 
 
== Editing help ==
 
Editing help is available here: [[Help:Editing]].
 

Latest revision as of 18:31, 28 September 2011

This page contains information on how one should edit this wiki, eg: best practices, protocols, templates and the like.

These pages are a highly recommended read:

Recommendations for editors
How to configure your account and to make sure your information gets displayed correctly.
Oh God how does any of this work (Tutorial)
Quickly get up to speed with adding content. Has a nifty Self-education section that helps you discover exactly how things work around here.
Content policy
What goes onto the wiki and what does not.
Naming protocol
How to choose and spell names, terms, titles and the like.
Creating pages
Helpful guides to creating pages. Contains nifty stuff with templates and examples that will reduce the amount of work you'll have to do.
Example pages
Your first stop for creating pages.
Categories and properties
What they are, how they are used, and how to create new ones.
Editing help
Help with syntax, formatting and other practicalities.

Notice

This site has a lot of dynamically generated content, making heavy use of templates and the semantic mediawiki extension. If anything looks broken or incorrect, please use the corresponding talk page to notify the person responsible. If all else fails, please notify User_talk:Joel Hedlund (NSC).