Difference between revisions of "WikEmacs:Guidelines"

From WikEmacs
Jump to: navigation, search
(bUEHPVokqD)
(Creating new pages: fix link. Would be better to remove /index.php/ entirely from the URL!)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Thanks for the recommendations on ciredt repair on this excellent web-site. A few things i would advice people is to give up the actual mentality they will buy at this moment and fork out later. Like a society many of us tend to do this for many issues. This includes trips, furniture, and also items we would like. However, you'll want to separate your own wants out of the needs. While you're working to improve your ciredt rating score actually you need some trade-offs. For example you are able to shop online to save cash or you can check out second hand outlets instead of high-priced department stores regarding clothing.
+
'''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]]

Latest revision as of 22:33, 24 April 2013

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[edit]

Creating new pages[edit]

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[edit]

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[edit]

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