Difference between revisions of "Help:Contents"
(Add WikiAccount Link) |
|||
Line 7: | Line 7: | ||
==How to edit== | ==How to edit== | ||
− | http://meta.wikimedia.org/wiki/Help:Editing | + | Wiki pages are mostly plain text with a few basic formatting characters. |
+ | |||
+ | Read this tutorial: http://meta.wikimedia.org/wiki/Help:Editing | ||
+ | |||
+ | In about 2 pages it explains the basic concepts & formatting characters. It also has loads of good links you can come back to later when you want to know more. At that point, the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] is also a good entry page. | ||
==How to write== | ==How to write== | ||
+ | |||
Writing a web page is different than writing a document. | Writing a web page is different than writing a document. | ||
Line 16: | Line 21: | ||
* [http://www.useit.com/alertbox/20030811.html Information Pollution] | * [http://www.useit.com/alertbox/20030811.html Information Pollution] | ||
− | == | + | ==How to use MediaWiki== |
− | The | + | |
+ | The links that are always available along the left and across the top provide a lot of useful features. | ||
+ | ===Search=== | ||
− | + | The search box on the left lets you do keyword searches on the site contents. You can change the scope of the search in your preferences. | |
− | |||
+ | ===Recent Changes=== | ||
+ | |||
+ | The Recent Changes link in the navigation box takes you to the Recent Changes page. Every edit to any wiki page is listed from newest to oldest. Clicking on the (diff) link lets you see what the edit changed. Clicking on the page link itself lets you see that version. Clicking on the (hist) link lets you see the history of changes to that page. | ||
==Conventions== | ==Conventions== | ||
Line 30: | Line 39: | ||
'''Adding In-line Comments''' - Use '''''<bold italic text in angle brackets>''''' when adding comments about the page contents | '''Adding In-line Comments''' - Use '''''<bold italic text in angle brackets>''''' when adding comments about the page contents | ||
− | |||
− | |||
− | |||
− | |||
==Useful Tricks== | ==Useful Tricks== | ||
− | |||
− | |||
− | |||
'''Table of Contents''' | '''Table of Contents''' | ||
Line 168: | Line 170: | ||
Explain User page, watchlists, my contributions, Recent Changes, Look into My Talk, | Explain User page, watchlists, my contributions, Recent Changes, Look into My Talk, | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Changing Size=== | ===Changing Size=== | ||
Line 220: | Line 189: | ||
− | ==Text Line Controls== | + | ===Text Line Controls=== |
* To force a hard Carriage-Return/Line-feed in the displayed document, use the following charcter sequence | * To force a hard Carriage-Return/Line-feed in the displayed document, use the following charcter sequence | ||
Line 229: | Line 198: | ||
<nowiki> <center>...</center> </nowiki> | <nowiki> <center>...</center> </nowiki> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | === | + | ===Tables=== |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Wikicode can be used to create a table, as follows: | Wikicode can be used to create a table, as follows: | ||
Line 305: | Line 210: | ||
*the first cell of a row is identified as row heading by starting the line with "!" instead of "|", and starting subsequent data cells on a new line. | *the first cell of a row is identified as row heading by starting the line with "!" instead of "|", and starting subsequent data cells on a new line. | ||
− | ==Example== | + | ====Example==== |
<nowiki>{| </nowiki> | <nowiki>{| </nowiki> | ||
Line 331: | Line 236: | ||
− | + | ===Term with indented definition:=== | |
− | |||
− | |||
− | |||
− | =Term with indented definition:= | ||
<nowiki>;Term:Definition (indented)</nowiki> | <nowiki>;Term:Definition (indented)</nowiki> | ||
Line 350: | Line 251: | ||
− | + | ===Miscellaneous Rules=== | |
− | =Miscellaneous Rules= | ||
*To quote text without applying the wiki formatting rules, enclose it within a <nowiki> ... </nowiki> section. Within a nowiki section, only HTML-quoting of special characters (<>&) will occur--no other formatting rules will be applied. | *To quote text without applying the wiki formatting rules, enclose it within a <nowiki> ... </nowiki> section. Within a nowiki section, only HTML-quoting of special characters (<>&) will occur--no other formatting rules will be applied. | ||
− | |||
− | |||
− | |||
[[Category:English Documentation]] | [[Category:English Documentation]] |
Revision as of 18:51, 27 October 2006
A wiki is basically a website you can edit.
To edit a page, click the edit tab at the top, edit the material in the input box then click the Save page button at the bottom.
Create a user account so we can keep track of who is doing what.
How to edit
Wiki pages are mostly plain text with a few basic formatting characters.
Read this tutorial: http://meta.wikimedia.org/wiki/Help:Editing
In about 2 pages it explains the basic concepts & formatting characters. It also has loads of good links you can come back to later when you want to know more. At that point, the User's Guide is also a good entry page.
How to write
Writing a web page is different than writing a document.
These links provide some useful insight.
How to use MediaWiki
The links that are always available along the left and across the top provide a lot of useful features.
Search
The search box on the left lets you do keyword searches on the site contents. You can change the scope of the search in your preferences.
Recent Changes
The Recent Changes link in the navigation box takes you to the Recent Changes page. Every edit to any wiki page is listed from newest to oldest. Clicking on the (diff) link lets you see what the edit changed. Clicking on the page link itself lets you see that version. Clicking on the (hist) link lets you see the history of changes to that page.
Conventions
Using Templates - We may have template for some types of pages (maybe referenced in the See Also section). To use the template, click it's link, click "Edit", and select and copy all the text in the edit window. Then go to your new page, and paste the template text into the edit window.
Adding Instructions to Editors - Use <italic text in angle brackets> when adding instructions to editors, for example in a template
Adding In-line Comments - Use <bold italic text in angle brackets> when adding comments about the page contents
Useful Tricks
Table of Contents
All pages with more than two headers include a Table of Contents at the top of the page with each of the section headers included as links. To move the TOC, insert the text __TOC__ at the point in the page where you would like it to appear. To remove the TOC, insert the text __NOTOC__ at the start of the page.
Combined Pages
To combine several existing pages into a single meta page when it makes sense to do so for viewing or printing, create a new page with the following syntax:
- =Optional Heading=
- {{:Page page1}}
- {{:Page page2}}
- and so on
Printing Pages
To get a printable page with BIG HEADERS:
- click on Printable View in the toolbox on the left
- print from the browser.
To get a document formatted for paper:
- click on Printable View in the toolbox on the left
- select and copy all the text in the Printable View
- open an empty Microsoft Word document
- paste the text into the Word document
- File->Page Setup-> reset the margins
- Tools->Templates and Add-ins
- <explain how to import/overwrite the appropriate paragraph styles>
- print from Word
Spellchecking
There are client side spell checkers that will check what you edit:
- Google Toolbar v3.0 for Explorer (http://toolbar.google.com/)
- ieSpell v2.1.1 for Explorer (http://www.iespell.com/)
- Spellbound for Firefox (http://wiki.ehow.com/Install-a-Spell-Checker-Into-Firefox)
Uploading Files
To avoid the broken link icon at the link to your uploaded file, add a : at the start of the link. E.g. [[:Media:NameOfYourFile.doc | link text]]
Converting Pages to HTML Files
mw2html is a tool for doing just this. Right click on this link and "Save Target as.." mw2html.py
It can be run with a Python binary package.
You will also need to get the htmldata module. Do a "Save Target As..." on the newest version link on that page. I don't remember off-hand how I got it to compile.
Once it's ready, try: "mw2html.py http://172.16.16.134/wiki/ out -f"
The current problem is that it doesn't use the login cookie cached for the browser so it only gets the top page right, but otherwise looks like it is doing the right thing.
I tested mw2html and it worked ok. Currently, our wiki allow anonymous users to view main page, logon page, and help page only. So mw2html.py can only get logon pages for others. Because of that, mw2html went pretty fast. I expect it will run lot longer when I allow anonymous user to view all pages.- howard
PDF Export
Combining articles into a single PDF for printing. It needs htmldoc (open source utility) to take multiple HTML pages and turn them into a PDF file. All pdf files stored on wiki server's folder called /printouts.
The coding is very simple and works like this: (we'll call this page "Test Print")
Put articles that will appear in sequence in curly braces: {Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
and put articles to combine into a single set of curly braces separated by the | pipe symbol. {Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports} These articles will not have a page break in the PDF file. This is really useful for articles that are short and related, such as a function list. Then add a link to this page:
Now when a user browses to this page on your site and clicks the above link, the page will re-output through the special PrintArticles.php file instead of index.php. The page will be changed from looking like this:
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
Print these articles
to this:
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
Print these articles
Creating: (Index_of_Work_Items)
Creating: (Feature_Proposals_Index)
Creating: (Index_of_Trend_Reports)
Known Problems:
- HTMLDOC can import images when running from command line but not reliable when spawn from wiki.
- Quotes print out as: a with an accent
- Funky caching issues
Task Lists
The MediaWikiTasks plugin supports managing task lists.
Timelines
The EasyTimelines plugin supports displaying annotated timelines.
See Also
MediaWiki and Wikipedia, the free encyclopedia provide more information and examples of using MediaWiki.
Wiki Introduction provides a short video outlining the use of Wiki's for collaboration
Wiki Features
Neat stuff under special pages. Explain Categories and Category Pages. Discussion Page: If you feel it useful/necessary, explain the purpose of the page or the rationale of it's structure. If you are about to make a major change to a page, check the Discussion to make sure you aren't misunderstanding the page. If you are going ahead with a major change, consider documenting your rationale.
Explain User page, watchlists, my contributions, Recent Changes, Look into My Talk,
Changing Size
To change the font size from the normal size to a size larger use the following:
- <big> ...text </big>
To change the font size from the normal size to a size smaller use the following:
- <small> ...text </small>
Changing Types
Changing Colors
To change the color of the font being displayed use the following:
- <font color=red> ...text </font>
Text Line Controls
- To force a hard Carriage-Return/Line-feed in the displayed document, use the following charcter sequence
<br />
- To center a text line, or all test between start fo HTML Tag and end of HTML tag.
<center>...</center>
Tables
Wikicode can be used to create a table, as follows:
- The entire table begins with a line "{| optional table parameters " and ends with the line "|}".
- An optional table caption is included with a line "|+ caption " after "{|".
- The code for a table row consists of the line "|- optional table parameters ", and, starting on a new line, the codes for the cells in the row, separated by newline or "|"
- Table data are the codes for the cells; cell code is of the form "| value " or "| cell parameters | value "
- a row of column headings is identified by using "!" instead of "|", except for the separator between a cell parameter and a value; the difference with a normal row depends on the browser, column headings are often rendered in a bold font.
- the first cell of a row is identified as row heading by starting the line with "!" instead of "|", and starting subsequent data cells on a new line.
Example
{|
| Cell 1, row 1
| Cell 2, row 1
|-
| Cell 1, row 2
| Cell 2, row 2
|}
generate
Cell 1, row 1 | Cell 2, row 1 |
Cell 1, row 2 | Cell 2, row 2 |
Term with indented definition:
;Term:Definition (indented)
;;Term (indented):Definition (indented two levels)
;;;Term (indented twice):Definition (indented to third level)
...which looks like:
- Term
- Definition (indented)
- Term (indented)
- Definition (indented two levels)
- Term (indented twice)
- Definition (indented to third level)
Miscellaneous Rules
- To quote text without applying the wiki formatting rules, enclose it within a ... section. Within a nowiki section, only HTML-quoting of special characters (<>&) will occur--no other formatting rules will be applied.