Difference between revisions of "Help:Beginner's guide"

From AVENwiki
Jump to: navigation, search
(Starting out: cleanup, rmv Wikieducator)
(Backlink)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
:<small>< back to [[Help:Contents]]</small>
 +
 
== First things first ==
 
== First things first ==
  
 
=== Starting out ===
 
=== Starting out ===
  
If you aren't familiar with mediawiki syntax, check out [[Wikitext markup]]. This covers basic wiki commands and style. Of course, to edit a page, you really only need to click the '''edit''' tab and start changing text, but knowing how to format pages will help you present information more clearly and effectively.
+
If you aren't familiar with mediawiki syntax, check out [[Help:Wikitext markup|Wikitext markup]]. This covers basic wiki commands and style. Of course, to edit a page, you really only need to click the '''edit''' tab and start changing text, but knowing how to format pages will help you present information more clearly and effectively.
  
 
You should also create your user profile, which can be found in the upper right. Generally, every time you make a new page, you should categorize it. A list of existing categories can be found [[Special:Categories|here]], but don't be afraid to create your own if you feel the need.
 
You should also create your user profile, which can be found in the upper right. Generally, every time you make a new page, you should categorize it. A list of existing categories can be found [[Special:Categories|here]], but don't be afraid to create your own if you feel the need.
Line 15: Line 17:
 
To talk about what you think should be on a page, use the related discussion page instead of the article itself (these are tabbed in the upper left of each page). To talk to other users, leave a note on their user talk page, <nowiki>[[User talk:USERNAME]]</nowiki>.
 
To talk about what you think should be on a page, use the related discussion page instead of the article itself (these are tabbed in the upper left of each page). To talk to other users, leave a note on their user talk page, <nowiki>[[User talk:USERNAME]]</nowiki>.
  
== Templates and userboxes ==
+
== Templates ==
  
You can copy/paste templates into new pages to save yourself some work. Templates are named a little differently from normal pages, like this: <nowiki>[[Template:Templatename]]</nowiki>. There are two ways to insert templates.
+
You can copy/paste templates into new pages to save yourself some work. Templates page names have "Template:" as a prefix, to distinguish it from normal articles. There are two ways to insert templates.
  
=== Static templates ===
+
=== Using templates ===
  
If you just want to insert a block of text (like the [http://en.wikipedia.org/wiki/Template:Stub Wikipedia stub template]), simply put curly braces and the name of the template. For example, to insert the stub template into a page, you would insert
+
If you just want to insert a block of text (like [[Template:Stub]]), simply put curly braces and the name of the template. For example, to insert the stub template into a page, you would insert
 
  <nowiki>{{Stub}}</nowiki>
 
  <nowiki>{{Stub}}</nowiki>
 
Note that the first part, "Template:" is left off.
 
Note that the first part, "Template:" is left off.
  
 
This will not convert to wikitext, so you can only change what the inserted text says by changing the original template. This is good for marking things like stubs, that don't need a customized message.
 
This will not convert to wikitext, so you can only change what the inserted text says by changing the original template. This is good for marking things like stubs, that don't need a customized message.
 
=== Dynamic templates ===
 
 
What if you wanted to edit the text in your template after inserting it? Then you would insert
 
<nowiki>{{subst:Stub}}</nowiki>
 
The substitute command will convert to wikitext after you save the page. So, you can insert a template with subst:, save the page, and then edit it again to replace the included text.
 
  
 
=== Useful templates ===
 
=== Useful templates ===
Line 38: Line 34:
 
* [[Template:Romantic|Romantic orientation navbar]] (use <nowiki>{{Romantic}}</nowiki>)
 
* [[Template:Romantic|Romantic orientation navbar]] (use <nowiki>{{Romantic}}</nowiki>)
 
* [[Template:Sexuality|Sexual orientation navbar]] (use <nowiki>{{Sexuality}}</nowiki>)
 
* [[Template:Sexuality|Sexual orientation navbar]] (use <nowiki>{{Sexuality}}</nowiki>)
* [[Template:Sidebar|Sexual orientation sidebar]] (use <nowiki>{{Sidebar}}</nowiki>)
 
  
Also, see the [http://www.asexuality.org/wiki/index.php?title=Special:AllPages&namespace=10 full list of templates].
+
Also, see the [[Special:AllPages/Template:|full list of templates]].
  
 
== Style Guide ==
 
== Style Guide ==
  
In order for our wiki to be coherent and readable, everyone should follow a basic set of stylistic conventions (this page is inspired by [http://wiki.laptop.org/go/Style_guide the OLPC style guide]).
+
In order for our wiki to be coherent and readable, everyone should follow a basic set of stylistic conventions. Usually we follow the [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia MoS].
  
 
=== Naming pages ===
 
=== Naming pages ===
Line 67: Line 62:
 
* avoid running together words in CamelCase unless you are referring to a proper noun (like MediaWiki); this allows for easier reading and comprehension
 
* avoid running together words in CamelCase unless you are referring to a proper noun (like MediaWiki); this allows for easier reading and comprehension
  
=== Headers ===
 
  
DO NOT use H1 headers (single =) within a page; start with H2 headers. H1 headers indicate the title of a page, so using them within a page should signify inclusion of an entire new page.
 
  
 
=== General writing ===
 
=== General writing ===
Line 80: Line 73:
 
=== Color ===
 
=== Color ===
  
In general, avoid using colored text. To emphasize text, use <nowiki>'' or '''</nowiki>
+
In general, avoid using colored text. To emphasize text, use <nowiki>''</nowiki>''italics'' <nowiki>''</nowiki> or <nowiki>'''</nowiki>'''bold text'''<nowiki>'''</nowiki>.
  
 
== Questions? ==
 
== Questions? ==
  
Don't understand something? Want some help? Contact Jaybird721 [[http://asexuality.org/discussion/profile.php?mode=viewprofile&u=10362 on AVEN]] or [[User talk:Jaybird721|on the wiki]].
+
Don't understand something? Want some help? Contact an [[AVENwiki:Administrators|admin]] on the wiki.
  
 
==See also==
 
==See also==
* [[Help:Editing|Editing Basics]]
+
* [[Help:Editing]]
* For a full list of editing commands, see [[Wikitext markup]]
+
* For a full list of editing commands, see [[Help:Wikitext markup]]
 
* To experiment with editing, use the [[AVENwiki:Sandbox]]
 
* To experiment with editing, use the [[AVENwiki:Sandbox]]
 +
 
[[Category:AVENwiki basic information]]
 
[[Category:AVENwiki basic information]]

Latest revision as of 14:27, 10 October 2013

< back to Help:Contents

First things first

Starting out

If you aren't familiar with mediawiki syntax, check out Wikitext markup. This covers basic wiki commands and style. Of course, to edit a page, you really only need to click the edit tab and start changing text, but knowing how to format pages will help you present information more clearly and effectively.

You should also create your user profile, which can be found in the upper right. Generally, every time you make a new page, you should categorize it. A list of existing categories can be found here, but don't be afraid to create your own if you feel the need.

The best way to get familiar with the wiki is to use it, exploring different ways to present information and format articles. You can go to the sandbox for experimenting and playing with syntax, so that you can try out new things without affecting pages in the wiki.

Editing pages

Feel free to edit pages, but be respectful of others. Keep your tone neutral, include citations if possible, and link to discussion threads when referencing them.

To talk about what you think should be on a page, use the related discussion page instead of the article itself (these are tabbed in the upper left of each page). To talk to other users, leave a note on their user talk page, [[User talk:USERNAME]].

Templates

You can copy/paste templates into new pages to save yourself some work. Templates page names have "Template:" as a prefix, to distinguish it from normal articles. There are two ways to insert templates.

Using templates

If you just want to insert a block of text (like Template:Stub), simply put curly braces and the name of the template. For example, to insert the stub template into a page, you would insert

{{Stub}}

Note that the first part, "Template:" is left off.

This will not convert to wikitext, so you can only change what the inserted text says by changing the original template. This is good for marking things like stubs, that don't need a customized message.

Useful templates

Also, see the full list of templates.

Style Guide

In order for our wiki to be coherent and readable, everyone should follow a basic set of stylistic conventions. Usually we follow the Wikipedia MoS.

Naming pages

  • check for alternative capitalizations; it would be awfully confusing to have a page named "Project Team" and another page named "Project team"
  • avoid capitalizing titles, unless there are proper nouns (for example, "Beginner's guide", not "Beginner's Guide")

Subpages

Subpage creation should be carefully considered and general avoided. Good uses of subpages include:

  • user subpages - it's fine to make [[User:USERNAME/Sandbox]] or [[User:USERNAME/Brainstorming]]
  • archive pages of a general page - for example, [[Boston meetups]] could give general information for planning the latest meet, and [[Boston meetups/Jan 12 2007]] could give information about a specific past meetup

Looking to the future

You should start a page with the most generalized name possible. For example, start by making [[Boston meetups]] and not [[Boston meetups 2008]].

Links

  • when linking within the wiki, use spaces instead of underscores, even if they go to the same place - i.e. [[Boston meetups]] instead of [[Boston_meetups]]
  • avoid running together words in CamelCase unless you are referring to a proper noun (like MediaWiki); this allows for easier reading and comprehension


General writing

  • write clearly
  • try to avoid words with unclear or multiple meanings
  • avoid making pages dependent on one another; this makes reading and editing unnecessarily difficult
  • categorize pages!

Color

In general, avoid using colored text. To emphasize text, use ''italics '' or '''bold text'''.

Questions?

Don't understand something? Want some help? Contact an admin on the wiki.

See also