Difference between revisions of "WikEmacs:Guidelines"
Jump to navigation
Jump to search
(Improve readability) |
|||
| Line 1: | Line 1: | ||
| − | + | '''If you take something from here, you are morally obliged to give something back.''' | |
| − | + | = Quick links = | |
| + | * [http://meta.wikimedia.org/wiki/Help:Wikitext_examples Help with Mediawiki markup] | ||
| + | * Create new page with [[#Creating new pages]] | ||
| + | |||
| + | = Quality guidelines == | ||
* Stick to Emacs-24 and Emacs-23. | * Stick to Emacs-24 and Emacs-23. | ||
* Keep things short and sweet. Mark things that should stand out in '''bold'''. | * 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. | * 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. | ||
| Line 9: | Line 14: | ||
* If you are a regular blogger, consider donating your article to this Wiki. | * If you are a regular blogger, consider donating your article to this Wiki. | ||
* Use '''Discussion page''' to discuss things. Don't put them in articles themselves. Remember to sign your comments using <nowiki>~~~~</nowiki>. | * Use '''Discussion page''' to discuss things. Don't put them in articles themselves. Remember to sign your comments using <nowiki>~~~~</nowiki>. | ||
| − | |||
* Extensions and packages will '''not''' be hosted here. If you are looking for a place to host your extension try [https://github.com GitHub] or one of the other many hosting / source control platforms out there! | * Extensions and packages will '''not''' be hosted here. If you are looking for a place to host your extension try [https://github.com GitHub] or one of the other many hosting / source control platforms out there! | ||
Revision as of 05:37, 28 March 2012
If you take something from here, you are morally obliged to give something back.
Quick links
- Help with Mediawiki markup
- Create new page with #Creating new pages
Quality guidelines =
- 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. Categorize them so it is easy to find.
- If you are a regular blogger, consider donating your article to this Wiki.
- Use Discussion page to discuss things. Don't put them in articles themselves. Remember to sign your comments using ~~~~.
- Extensions and packages will not be hosted here. If you are looking for a place to host your extension try GitHub or one of the other many hosting / source control platforms out there!
Creating new pages
To create a new page, do this:
- Visit Template:NewPage and copy the text area to clipboard. Feel free to modify the template.
- Goto WikEmacs:Scratch Buffer
- Add this [[Test Page]] 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 uniform experience. See Special:UncategorizedTemplates.
Some examples:
| What it looks like | What you type |
|---|---|
| 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}}
|
| M-x find-file | {{Command|find-file}}
|
| M-x customize-variable RET c-default-style | {{CustomizeVariable|c-default-style}}
|
| M-x customize-group RET C RET | {{CustomizeGroup|C}}
|
| search-forward | {{Function|search-forward}}
|
| auto-mode-alist | {{Variable|auto-mode-alist}}
|
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.