https://wikemacs.org/api.php?action=feedcontributions&user=186.137.117.70&feedformat=atomWikEmacs - User contributions [en]2024-03-19T07:18:08ZUser contributionsMediaWiki 1.35.14https://wikemacs.org/index.php?title=WikEmacs:Guidelines&diff=4512WikEmacs:Guidelines2013-04-25T02:33:31Z<p>186.137.117.70: /* Creating new pages */ fix link. Would be better to remove /index.php/ entirely from the URL!</p>
<hr />
<div>'''How can we maintain and improve quality of this Wiki?'''<br />
* Stick to Emacs-24 and Emacs-23.<br />
* Keep things short and sweet. Mark things that should stand out in '''bold'''. <br />
* Use [http://en.wikipedia.org/wiki/Active_voice Active voice]<br />
* Give tips. Document things that are difficult to find or share your wisdom.<br />
* Don't reproduce existing documentation. Instead link to them.<br />
* It's OK to write long tutorial Pages. Use '''Tutorial:Tutorial Namespace''' for it. Assign categories for easily finding the tutorial.<br />
* If you are a regular blogger, consider donating your articles to this Wiki.<br />
* For discussions, use the '''Discussion page''' instead of posting to the article pages. Sign your comments using <nowiki>~~~~</nowiki>. <br />
* We cannot host code extensions and elisp packages here. Use [https://github.com GitHub] or similar code hosting site.<br />
* {{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.<br />
* '''Code snippets''' are most welcome. But comment about what precisely the snippet does. Document any limitations as well. <br />
<br />
== Mediawiki Help == <br />
* [http://meta.wikimedia.org/wiki/Help:Wikitext_examples Help with Mediawiki markup]<br />
<br />
== Creating new pages ==<br />
To create a new page, do this:<br />
# 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. <br />
# Goto [[WikEmacs:Scratch Buffer]]<br />
# Add this <nowiki>[[Test Page]]</nowiki> and save the scratch buffer.<br />
# Click on the new Wiki link to create a blank page and paste the contents of clipboard there.<br />
# Save the newly created page.<br />
# Now you have a basic template which you can expand upon. Add content to the new page as you please.<br />
<br />
== Templates ==<br />
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:<br />
<br />
{| border="1" cellpadding="5" cellspacing="0" width="75%"<br />
|-<br />
!What it looks like<br />
!What you type<br />
|-<br />
| <h2>Headline text</h2><br />
| <pre>== Headline text ==</pre><br />
|-<br />
| {{Manual|emacs|Major-Modes|Major Modes}}<br />
| <pre>{{Manual|emacs|Major-Modes|Major Modes}}</pre><br />
|-<br />
| {{CommandKeys|C-x C-f|find-file}}<br />
| <pre>{{CommandKeys|C-x C-f|find-file}}</pre><br />
|-<br />
| {{Keys|C-x C-c}}<br />
| <pre>{{Keys|C-x C-c}}</pre><br />
|-<br />
| {{Keys|C-x f|set-fill-column}}<br />
| <pre>{{Keys|C-x f|set-fill-column}}</pre><br />
|-<br />
| {{Command|find-file}} <br />
| <pre>{{Command|find-file}}</pre> <br />
|-<br />
| {{CustomizeVariable|c-default-style}} <br />
| <pre>{{CustomizeVariable|c-default-style}}</pre><br />
|-<br />
| {{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}<br />
| <pre>{{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}</pre><br />
|}<br />
<br />
== Categories ==<br />
<br />
Special categories, such as ''Operating system'', ''Emacs releases'', ''Programming languages'', should be used to introduce new categories. See [[Special:Categories]].<br />
<br />
[[Category:WikEmacs Contributor]]</div>186.137.117.70