WikEmacs:Guidelines

2013-04-25T02:33:31Z

186.137.117.70: /* Creating new pages */ fix link. Would be better to remove /index.php/ entirely from the URL!

'''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 [http://en.wikipedia.org/wiki/Active_voice 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 <nowiki>~~~~</nowiki>.
* 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. 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.
* '''Code snippets''' are most welcome. But comment about what precisely the snippet does. Document any limitations as well.

== Mediawiki Help ==
* [http://meta.wikimedia.org/wiki/Help:Wikitext_examples Help with Mediawiki markup]

== Creating new pages ==
To create a new page, do this:
# Visit [http://wikemacs.org/index.php/Template:NewPage?action=edit Template:NewPage] and copy the text area to clipboard. Feel free to modify the template.
# Goto [[WikEmacs:Scratch Buffer]]
# Add this <nowiki>[[Test Page]]</nowiki> and save the scratch buffer.
# Click on the new Wiki link to create a blank page and paste the contents of clipboard there.
# Save the newly created page.
# 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:

{| border="1" cellpadding="5" cellspacing="0" width="75%"
|-
!What it looks like
!What you type
|-
| <h2>Headline text</h2>
| <pre>== Headline text ==</pre>
|-
| {{Manual|emacs|Major-Modes|Major Modes}}
| <pre>{{Manual|emacs|Major-Modes|Major Modes}}</pre>
|-
| {{CommandKeys|C-x C-f|find-file}}
| <pre>{{CommandKeys|C-x C-f|find-file}}</pre>
|-
| {{Keys|C-x C-c}}
| <pre>{{Keys|C-x C-c}}</pre>
|-
| {{Keys|C-x f|set-fill-column}}
| <pre>{{Keys|C-x f|set-fill-column}}</pre>
|-
| {{Command|find-file}}
| <pre>{{Command|find-file}}</pre>
|-
| {{CustomizeVariable|c-default-style}}
| <pre>{{CustomizeVariable|c-default-style}}</pre>
|-
| {{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}
| <pre>{{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}</pre>
|}

== Categories ==

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

[[Category:WikEmacs Contributor]]

WikEmacs - User contributions [en]

WikEmacs:Guidelines