Difference between revisions of "CS61A Wiki:How-to guide"

From CS 61A Wiki
Jump to: navigation, search
[unchecked revision][checked revision]
(created)
 
m (nowiki)
 
(One intermediate revision by one user not shown)
Line 5: Line 5:
 
* Avoid using technical language gratuitously. Explain or link terms that might reasonably be unknown to a 61A student. See {{plain link|//en.wikiversity.org/wiki/Technical_writing_style|this}} for guidance on technical writing.
 
* Avoid using technical language gratuitously. Explain or link terms that might reasonably be unknown to a 61A student. See {{plain link|//en.wikiversity.org/wiki/Technical_writing_style|this}} for guidance on technical writing.
 
* Don't overlink. Links for any single term should not be excessively repeated in the same article.
 
* Don't overlink. Links for any single term should not be excessively repeated in the same article.
* Article titles and section headings should be in sentence case (first word capitalized, rest lowercase), not title case, unless the phrases are proper nouns. Section headers should be <code>== level 2 headers ==</code> and add another equal sign (<code>=</code>) for subsections.
+
* Article titles and section headings should be in sentence case (first word capitalized, rest lowercase), not title case, unless the phrases are proper nouns. Section headers should be <code><nowiki>== level 2 headers ==</nowiki></code> and add another equal sign (<code>=</code>) for subsections.
  
 
== Formatting ==
 
== Formatting ==
Line 27: Line 27:
  
 
== Talk page conventions ==
 
== Talk page conventions ==
Use talk pages (example: [[Talk:Higher-order functions]]) to discuss improvements to the associated article.
+
Use talk pages (example: [[Talk:Higher-order function]]) to discuss improvements to the associated article.
 
* Always sign your username after your comments with four tildes (<code><nowiki>~~~~</nowiki></code>).
 
* Always sign your username after your comments with four tildes (<code><nowiki>~~~~</nowiki></code>).
* Start a new discussion with a <code>== level 2 heading ==</code> at the bottom of the page.
+
* Start a new discussion with a <code><nowiki>== level 2 headers ==</nowiki></code> at the bottom of the page.
 
* Indent replies with colons (<code>:</code>) at the beginning of the line.
 
* Indent replies with colons (<code>:</code>) at the beginning of the line.

Latest revision as of 19:27, 18 June 2014

Style

  • Keep your writing informative and not too casual, not too formal.
  • Avoid using technical language gratuitously. Explain or link terms that might reasonably be unknown to a 61A student. See this for guidance on technical writing.
  • Don't overlink. Links for any single term should not be excessively repeated in the same article.
  • Article titles and section headings should be in sentence case (first word capitalized, rest lowercase), not title case, unless the phrases are proper nouns. Section headers should be == level 2 headers == and add another equal sign (=) for subsections.

Formatting

We use MediaWiki formatting (the same as used on Wikipedia). For simple formatting, there is a WYSIWYG editor. For more details on wiki markup, see this and this.

Creating an article

  1. Before creating a new article, first make sure that an article on your topic does not already exist:
  2. In the search box in the upper right corner, enter your topic.
  3. If the exact topic exists, the article will open.
  4. Otherwise, you will get a list of search results. Check if your topic is in the results.
  5. If your topic does not exist, choose "create this page".

Editing an article

To edit an article:

  1. Make sure that you are logged in to the wiki. If you are not logged in, your edit will be attributed to your IP address. (Check Special:MyContributions to see your own edits.)
  2. Click the "Edit" tab.
  3. Enter your changes in the box.
  4. In the "Summary" box, enter a short explanation of what you did.
  5. Click "Show preview" if you want to check your changes.
  6. Click "Save page".

Talk page conventions

Use talk pages (example: Talk:Higher-order function) to discuss improvements to the associated article.

  • Always sign your username after your comments with four tildes (~~~~).
  • Start a new discussion with a == level 2 headers == at the bottom of the page.
  • Indent replies with colons (:) at the beginning of the line.