Difference between revisions of "WikEmacs:Guidelines"

From WikEmacs
Jump to: navigation, search
m
(Grammar and punctuation edits)
Line 5: Line 5:
 
* Give tips. Document things that are difficult to find or share your wisdom.
 
* Give tips. Document things that are difficult to find or share your wisdom.
 
* Don't reproduce existing documentation. Instead link to them.
 
* Don't reproduce existing documentation. Instead link to them.
* It's OK to write long tutorial Pages. Use '''Tutorial:Tutorial Namespace''' for it. Categorize them so it is easy to find.
+
* It's OK to write long tutorial Pages. Use '''Tutorial:Tutorial Namespace''' for it. Assign categories for easily finding the tutorial.
* If you are a regular blogger, donate your article to this Wiki.
+
* If you are a regular blogger, consider donating your articles to this Wiki.
* Use '''Discussion page''' to discuss things. Don't put them in articles themselves. Always sign your comments using  <nowiki>~~~~</nowiki>.  
+
* For discussions, use the '''Discussion page''' instead of posting to the article pages. Sign your comments using  <nowiki>~~~~</nowiki>.  
* We cannot host code extensions and elisp packages here. Use [https://github.com GitHub] or any other code hosting site.
+
* We cannot host code extensions and elisp packages here. Use [https://github.com GitHub] or similar code hosting site.
* {{Note}} this is not a QA site, any question you have are better answered at [http://stackoverflow.com/questions/tagged/emacs Stackoverflow site]. If have got answer to a good question add your solution in the appropriate page.
+
* {{Note}} this is not a QA site. Emacs questions are better answered at [http://stackoverflow.com/questions/tagged/emacs Stackoverflow site]. However, if you have an answer to a good question or problem, add in the appropriate page.
* Any '''Code snippets''' are most welcome., But please make sure to write comments about that, like that snippet precisely does. If it has any limitations, document them.
+
* '''Code snippets''' are most welcome. But comment about what precisely the snippet does. Document any limitations as well.  
  
 
== Mediawiki Help ==  
 
== Mediawiki Help ==  
Line 25: Line 25:
  
 
== Templates ==
 
== Templates ==
There are templates defined for referencing ''variables'', ''function'', ''command'', ''keys'', ''manual'' etc.  Use them for uniform experience.  See [[:Category:Templates]]. Each template page should describe how to use it. A few common examples:
+
There are templates defined for referencing ''variables'', ''function'', ''command'', ''keys'', ''manual'' etc.  Use them for uniformity.  See [[:Category:Templates]]. Each template page should describe how to use that template. A few common examples:
  
 
{| border="1" cellpadding="5" cellspacing="0" width="75%"
 
{| border="1" cellpadding="5" cellspacing="0" width="75%"
Line 31: Line 31:
 
!What it looks like
 
!What it looks like
 
!What you type
 
!What you type
 +
==
 +
== Headline text ==
 +
==
 +
 
|-
 
|-
 
| {{Manual|emacs|Major-Modes|Major Modes}}
 
| {{Manual|emacs|Major-Modes|Major Modes}}
Line 56: Line 60:
 
== Categories ==
 
== Categories ==
  
There are special categories defined for ''Operating system'', ''Emacs releases'', ''Programming languages'' etc. Use these when possible or introduce new ones as required. See [[Special:Categories]].
+
Special categories, such as ''Operating system'', ''Emacs releases'', ''Programming languages'', should be used to introduce new categories. See [[Special:Categories]].
  
 
[[Category:WikEmacs Contributor]]
 
[[Category:WikEmacs Contributor]]

Revision as of 01:47, 1 May 2012

How can we maintain and improve quality of this Wiki?

  • Stick to Emacs-24 and Emacs-23.
  • Keep things short and sweet. Mark things that should stand out in bold.
  • Use Active voice
  • Give tips. Document things that are difficult to find or share your wisdom.
  • Don't reproduce existing documentation. Instead link to them.
  • It's OK to write long tutorial Pages. Use Tutorial:Tutorial Namespace for it. Assign categories for easily finding the tutorial.
  • If you are a regular blogger, consider donating your articles to this Wiki.
  • For discussions, use the Discussion page instead of posting to the article pages. Sign your comments using ~~~~.
  • We cannot host code extensions and elisp packages here. Use GitHub or similar code hosting site.
  • Note Note: this is not a QA site. Emacs questions are better answered at Stackoverflow site. However, if you have an answer to a good question or problem, add in the appropriate page.
  • Code snippets are most welcome. But comment about what precisely the snippet does. Document any limitations as well.

Mediawiki Help

Creating new pages

To create a new page, do this:

  1. Visit Template:NewPage and copy the text area to clipboard. Feel free to modify the template.
  2. Goto WikEmacs:Scratch Buffer
  3. Add this [[Test Page]] and save the scratch buffer.
  4. Click on the new Wiki link to create a blank page and paste the contents of clipboard there.
  5. Save the newly created page.
  6. Now you have a basic template which you can expand upon. Add content to the new page as you please.

Templates

There are templates defined for referencing variables, function, command, keys, manual etc. Use them for uniformity. See Category:Templates. Each template page should describe how to use that template. A few common examples:

What it looks like What you type

==

Headline text

==
Major Modes (`(info "(emacs) Major Modes")')
{{Manual|emacs|Major-Modes|Major Modes}}
[C-x C-f] (or M-x find-file)
{{CommandKeys|C-x C-f|find-file}}
[C-x C-c]
{{Keys|C-x C-c}}
[C-x f]
{{Keys|C-x f|set-fill-column}}
M-x find-file
{{Command|find-file}}
M-x customize-variable RET c-default-style
{{CustomizeVariable|c-default-style}}
(global-set-key (kbd "C-c c") 'org-capture)
{{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}

Categories

Special categories, such as Operating system, Emacs releases, Programming languages, should be used to introduce new categories. See Special:Categories.