Difference between revisions of "WikEmacs:Guidelines"
Jump to navigation
Jump to search
m |
m (clean) |
||
| (22 intermediate revisions by 17 users not shown) | |||
| Line 1: | Line 1: | ||
'''How can we maintain and improve quality of this Wiki?''' | '''How can we maintain and improve quality of this Wiki?''' | ||
| − | * Stick to | + | * Stick to the current and future versions of Emacs. |
* 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] | * 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. | ||
| − | * It's OK to write long tutorial Pages. Use '''Tutorial:Tutorial Namespace''' for it. | + | * 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, | + | * 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 | + | * 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 the [http://emacs.stackexchange.com/ Emacs-specific StackExchange site] or on [http://stackoverflow.com/questions/tagged/emacs Stackoverflow]. However, if you have an answer to a good question or problem, add in the appropriate page. | |
| − | * {{Note}} this is not a QA site | + | * '''Code snippets''' are most welcome. But comment about what precisely the snippet does. Document any limitations as well. |
== Mediawiki Help == | == Mediawiki Help == | ||
| Line 17: | Line 17: | ||
== Creating new pages == | == Creating new pages == | ||
To create a new page, do this: | To create a new page, do this: | ||
| − | # Visit [http://wikemacs.org | + | # 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]] | # Goto [[WikEmacs:Scratch Buffer]] | ||
# Add this <nowiki>[[Test Page]]</nowiki> and save the scratch buffer. | # Add this <nowiki>[[Test Page]]</nowiki> and save the scratch buffer. | ||
| Line 25: | Line 25: | ||
== Templates == | == Templates == | ||
| − | There are templates defined for referencing ''variables'', ''function'', ''command'', ''keys'', ''manual'' etc. Use them for | + | 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 | ||
| + | |- | ||
| + | | <h2>Headline text</h2> | ||
| + | | <pre>== Headline text ==</pre> | ||
|- | |- | ||
| {{Manual|emacs|Major-Modes|Major Modes}} | | {{Manual|emacs|Major-Modes|Major Modes}} | ||
| Line 56: | Line 59: | ||
== Categories == | == Categories == | ||
| − | + | Special categories, such as ''Operating system'', ''Emacs releases'', ''Programming languages'', should be used to introduce new categories. See [[Special:Categories]]. | |
| − | [[Category:WikEmacs | + | [[Category:WikEmacs]] |
Latest revision as of 15:32, 8 March 2019
How can we maintain and improve quality of this Wiki?
- Stick to the current and future versions of Emacs.
- 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: this is not a QA site. Emacs questions are better answered at the Emacs-specific StackExchange site or on Stackoverflow. 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:
- 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 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 |
== 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.