Difference between revisions of "Help:Contents"

From IHE Wiki
Jump to: navigation, search
 
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
'''[[Wiki Map]]''' describes the high level layout of this wiki.
 +
 
A '''wiki''' is basically a website you can edit.
 
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.
 
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.
+
'''[[Wiki Accounts| Create a user account]]''' so we can keep track of who is doing what.
  
=How to edit=
+
Browse the '''[[How To's]]''' and the rest of this help page.
  
[[Help:FAQ|Frequently Asked Questions about MediaWiki]]
 
  
=How to write=
+
__TOC__
Writing a web page is different than writing a document.
+
  
These links provide some useful insight.
 
* [http://www.useit.com/alertbox/9710a.html How Users Read on the Web]
 
* [http://www.useit.com/alertbox/20030811.html Information Pollution]
 
  
==Search==
+
==How to edit==
The search box on the left lets you do keyword searches on the site contents.
+
  
 +
Wiki pages are mostly plain text with a few basic formatting characters.
 +
If you're nervous about formatting, just type plain text and leave a blank line to separate paragraphs.
  
==Editing==
+
Read this tutorial:  http://meta.wikimedia.org/wiki/Help:Editing
See the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for more detail.
+
  
 +
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.
  
==Conventions==
+
Many types of pages (e.g. specific Domains, specific Committees) have [[:Category:Templates| templates]] you can copy/paste when creating new pages.
'''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
+
If you want a safe place to practice editing, feel free to play in the [[Sandbox]] page.
  
'''Adding In-line Comments''' - Use '''''<bold italic text in angle brackets>''''' when adding comments about the page contents
+
Use '''[[:Category:Templates| Templates]]''' for creating typical pages.
  
 +
==How to write==
  
==Configuring==
+
Writing a web page is different than writing a document.
See [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface] and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for help on using and configuring a Wiki.
+
  
 +
These links provide some useful insight.
 +
* [http://www.useit.com/alertbox/9710a.html How Users Read on the Web]
 +
* [http://www.useit.com/alertbox/20030811.html Information Pollution]
  
==Useful Tricks==
+
==Text Conventions==
 +
'''''<These are just provisional and should be discussed>'''''
  
'''Recent Changes'''
+
Use '''bold text''' to emphasize topics.
  
The Recent Changes link in the navigation box is a useful way to track changes to the Wiki contents. Each page change is listed from most recent to oldest. Clicking on the (diff) link lets you see what changed.  Clicking on the page link itself lets you see the result.  Clicking on the (hist) link lets you see the history of changes to that page.
+
Use ''<italic text in angle brackets>'' for '''instructions to editors''', i.e. text that should be replaced and explains what goes there, such as in a template
  
'''Table of Contents'''
+
Use '''''<bold italic text in angle brackets>''''' when adding '''in-line comments''' about the contents of a page.
  
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 <nowiki>__TOC__</nowiki> at the point in the page where you would like it to appear.  To remove the TOC, insert the text <nowiki>__NOTOC__</nowiki> at the start of the page.
+
==How to use MediaWiki==
  
'''Combined Pages'''
+
The links that are always available on the left side and across the top of the page provide a lot of useful features.
  
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:
+
===Recent Changes / History===
  
:<nowiki>=Optional Heading=</nowiki>
+
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. 
:<nowiki>{{:Page page1}}</nowiki>
+
:<nowiki>{{:Page page2}}</nowiki>
+
:''and so on''
+
  
 +
You can also see past versions from the History tab on each page.
  
'''Printing Pages'''
+
===Watch / Watchlist===
  
To get a printable page with '''<big>BIG HEADERS</big>''':
+
The My watchlist link at the top is a filtered list that only shows changes to pages you have flagged by clicking the Watch tab at the top of each page.
* click on Printable View in the toolbox on the left
+
* print from the browser.
+
  
 +
===Search===
  
To get a document formatted for paper:
+
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.
* 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'''
+
===Printable Version===
  
There are client side spell checkers that will check what you edit:
+
The Printable Version link on the left generates a version of the current page more suitable for printing from your browser.
* 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)
+
  
 +
===Discussions===
  
'''Uploading Files'''
+
Each page has a Discussion tab at the top.  If you feel it useful/necessary, explain the purpose of the page or the rationale of it's structure here. 
  
To avoid the broken link icon at the link to your uploaded file, add a : at the
+
If you are about to make a major change to a page, check the Discussion page to make sure you aren't misunderstanding the pageIf you are going ahead with a major change, consider documenting your rationale.
start of the linkE.g. <nowiki>[[:Media:NameOfYourFile.doc | link text]]</nowiki>
+
  
 +
===User Page===
  
'''Converting Pages to HTML Files'''
+
Click on a user name (yours appears up at the top, others appear on history pages, etc) to get to their personal page.  Also at the top is a my talk link which takes you to the Discussion page associated with your user page.  Other users can leave you messages there.  You will be automatically notified when you log in if someone has updated your discussion/talk page.
  
mw2html is a tool for doing just this.  Right click on [http://oregonstate.edu/~barnesc/python/mw2html.py this link] and "Save Target as.." mw2html.py
+
Consider this [[User Page Template| template]] when creating your User Page.
  
It can be run with a [http://www.python.org/download/ Python] binary package.
+
===Special Pages===
  
You will also need to get the [http://oregonstate.edu/~barnesc/htmldata/ 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.
+
'''''<Need to explain the really handy pages under Special Pages>'''''
  
Once it's ready, try:
+
===Categories===
<nowiki>"mw2html.py http://172.16.16.134/wiki/ out -f"</nowiki>
+
  
'''''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.'''''
+
You can categorize pages by adding one or more [http://www.mediawiki.org/wiki/Category '''category'''] tags to the text. Adding a tag creates a link at the bottom of the article which take you to the list of all pages in that category, which makes it easy to browse related articles.
  
''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''
+
For example, add one of these to the bottom of a page:
  
 +
<nowiki>
 +
[[Category:Actor]]
 +
[[Category:Agenda]]
 +
[[Category:Minutes]]
 +
[[Category:Profiles]]
 +
[[Category:Templates]] </nowiki>
  
 +
In addtion, you can categorize each page based on its [[Domains | domain]] abbreviation:
  
'''PDF Export'''
+
<nowiki>
 +
[[Category:PCD]]</nowiki>
  
Combining articles into a single PDF for printing.
+
Add as many tags as you like, so your page will be found in as many appropriate category listings as makes sense.
It needs [http://www.htmldoc.org/ 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:  
+
Finally, you may want your category sorted differently. The following tag puts your page on the Profiles list, but sorted using the "SortMeHere" tag:
{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.
+
<nowiki>
{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:
+
  [[Category:Profiles | SortMeHere]]</nowiki>
   
+
[http://172.16.16.134/wiki/PrintArticles.php/Test_Print Print these articles]
+
  
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:
+
==Tips & Tricks==
  
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
+
'''Quasi-Back Button'''
  
Print these articles
+
If you have done several edits, when you use the browser "Back" button you will have to go back many times to get to the page you came from.
  
 +
As an alternative that takes two clicks, you can click on "What links here" in the Toolbox on the left side of the Wiki page.  The page you came from will be listed there an you can click on it.
  
to this:
+
'''Text Size'''
  
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
+
To change the font size from the normal size to <big>larger</big> or <small>smaller</small> use:
  
Print these articles
+
::<tt><nowiki>  <big> text  </big>      </nowiki></tt>
 +
::<tt><nowiki>  <small> text  </small>  </nowiki></tt>
  
Creating: (Index_of_Work_Items)
+
'''Text Color'''
  
Creating: (Feature_Proposals_Index)
+
To change the color of the <font color=red>font</font> being displayed use:
  
Creating: (Index_of_Trend_Reports)
+
::<tt><nowiki>  <font color=red> text </font>  </nowiki></tt>
  
[[Test Print]]
+
'''Line Formatting'''
  
Known Problems:
+
To force a hard Carriage-Return/Line-feed in the displayed document, either leave a blank line, or use:
*HTMLDOC can import images when running from command line but not reliable when spawn from wiki.
+
*Quotes print out as: a with an accent
+
::<tt><nowiki>  <br />  </nowiki></tt>
*Funky caching issues
+
  
 +
To center a text line, or all text between start HTML Tag and end HTML tag, use:
  
 +
::<tt><nowiki>  <center>text</center>  </nowiki></tt>
  
'''Task Lists'''
+
'''Quoting Text'''
  
The [http://wiki.arandeltac.com/MediaWiki_Tasks MediaWikiTasks] plugin supports managing task lists.
+
To quote text without applying the wiki formatting rules use:
 +
::<tt><nowiki>  <nowiki> text </nowiki>  </nowiki></tt>
  
 +
Within a nowiki section, only HTML-quoting of special characters (<>&) will occur--no other formatting rules will be applied.
  
'''Timelines'''
+
'''Embedding Images/Graphics/Documents'''
  
The [http://members.chello.nl/epzachte/Wikipedia/EasyTimeline/Introduction.htm EasyTimelines] plugin supports displaying annotated timelines.
+
First upload the jpg using the Upload File link on the left.  Then put a link to the jpg at the place you want the image to appear using the following format:
  
==See Also==
+
::<tt><nowiki>  [[Image:NameOfYourFile.jpg]]  </nowiki></tt>
[http://meta.wikimedia.org/wiki/MediaWiki MediaWiki] and [http://en.wikipedia.org/wiki/Main_Page Wikipedia, the free encyclopedia] provide more information and examples of using MediaWiki.
+
  
[http://news.zdnet.com/2036-2_22-5815948.html Wiki Introduction] provides a short video outlining the use of Wiki's for collaboration
+
You can also embed links to files such as:
  
Neat stuff under special pages. Explain Categories and Category Pages.
+
::<tt><nowiki> [[:Media:NameOfYourFile.doc | link text]]</nowiki></tt>
  
==Headings and Subheadings==
+
;Term (bolded term):Definition (with indented definition)
Headings and subheadings are an easy way to improve the organization of an article. If you can see two or more distinct topics being discussed, you can break up the article by inserting a heading for each [[Wikipedia:section|section]].
+
is accomplished by:
 +
::<tt><nowiki>  ;Term (bolded term):Definition (with indented definition)  </nowiki></tt>
  
Headings can be created like this:
+
'''Using Templates'''
*<tt><nowiki>==Top level heading==</nowiki></tt> (2 equals signs)
+
*<tt><nowiki>===Subheading===</nowiki></tt> (3 equals signs)
+
*<tt><nowiki>====Another level down====</nowiki></tt> (4 equals signs)
+
  
If an article has at least four headings, a table of contents will automatically be generated.
+
There are templates for some typical types of pages.  A page often has a link in the See Also section to the template it was created from.  
  
Note: there are six levels of document headers in MediaWiki.
+
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.
  
==Indenting==
+
'''Table of Contents'''
  
===Plain indentations===
+
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.
The simplest way of indenting is to place a [[Colon (punctuation)|colon]] (<tt>:</tt>) at the beginning of a line. The more colons you put, the further indented the text will be. A [[newline]] (pressing '''Enter''' or '''Return''') marks the end of the indented paragraph.
+
  
For example:
+
To move the TOC, insert the text <nowiki>__TOC__</nowiki> at the point in the page where you would like it to appear.
:<tt>This is aligned all the way to the left.</tt>
+
:<tt><nowiki>:</nowiki>This is indented slightly.</tt>
+
:<tt><nowiki>::</nowiki>This is indented more.</tt>
+
is shown as:
+
:This is aligned all the way to the left.
+
::This is indented slightly.
+
:::This is indented more.
+
  
==Working with FONTS==
+
To remove the TOC, insert the text <nowiki>__NOTOC__</nowiki> at the start of the page.
  
===Bold and Italics===
+
'''Combined Pages'''
The most commonly used wiki tags are '''bold''' and ''italics''. '''Bolding''' and ''italicizing'' is done by surrounding a word or phrase with multiple apostrophes (<tt>'</tt>):
+
  
*<tt><nowiki>''italics''</nowiki></tt> appears as ''italics''. (2 apostrophes on either side)
+
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:
*<tt><nowiki>'''bold'''</nowiki></tt> appears as '''bold'''. (3 apostrophes on either side)
+
*<tt><nowiki>'''''bolded italics'''''</nowiki></tt> appears as '''''bolded italics'''''.  (2&nbsp;+&nbsp;3&nbsp;=&nbsp;5 apostrophes on either side)
+
  
===Changing Size===
+
::<tt><nowiki>  ==Optional Heading== </nowiki></tt>
To change the font size from the normal size to a size <big>larger</big> use the following:  
+
::<tt><nowiki>  {{:Page page1}}      </nowiki></tt>
 +
::<tt><nowiki>  {{:Page page2}}      </nowiki></tt>
 +
::''and so on''
  
::<tt><nowiki>  <big> ...text  </big>  </nowiki></tt>
+
'''Printing Pages'''
  
To change the font size from the normal size to a size <small>smaller</small> use the following:  
+
To get a printable page with '''<big>BIG HEADERS</big>''':
 +
* click on Printable View in the toolbox on the left
 +
* print from the browser. 
  
::<tt><nowiki>  <small> ...text  </small>    </nowiki></tt>
 
  
===Changing Types===
+
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
 +
* '''''<still need to explain how to import/overwrite the appropriate paragraph styles>'''''
 +
* print from Word
  
 +
'''Spellchecking'''
  
===Changing Colors===
+
There are client side spell checkers that will check what you edit:
To change the color of the <font color=red>font</font> being displayed use the following:
+
* Google Toolbar for Explorer (http://toolbar.google.com/)
::<tt><nowiki>  <font color=red> ...text </font>  </nowiki></tt>
+
* ieSpell for Explorer (http://www.iespell.com/)
 +
* Spellbound for Firefox (http://wiki.ehow.com/Install-a-Spell-Checker-Into-Firefox)
  
 +
'''Task Lists'''
  
==Text Line Controls==
+
The [http://wiki.arandeltac.com/MediaWiki_Tasks MediaWikiTasks] plugin supports managing task lists.
* To force a hard Carriage-Return/Line-feed in the displayed document, use the following charcter sequence
+
+
<nowiki>        <br />  </nowiki>
+
  
* To center a text line, or all test between start fo HTML Tag and end of HTML tag.
+
'''Timelines'''
  
<nowiki>    <center>...</center>  </nowiki>
+
The [http://members.chello.nl/epzachte/Wikipedia/EasyTimeline/Introduction.htm EasyTimelines] plugin supports displaying annotated timelines.
  
=Links=
+
'''Converting Pages to HTML Files'''
  
==How to Link==
+
mw2html is a tool for doing just this.  Right click on [http://oregonstate.edu/~barnesc/python/mw2html.py this link] and "Save Target as.." mw2html.py
  
===Internal Links:===
+
It can be run with a [http://www.python.org/download/ Python] binary package.
When you want to make a link to another page in the same wiki (called a <em>wiki link</em>) you put it in double square brackets, like this:
+
:<tt><nowiki>[[Sandbox]]</nowiki></tt>
+
  
=== External links ===
+
You will also need to get the [http://oregonstate.edu/~barnesc/htmldata/ 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.
If you want to link to a site outside of the wiki, simply type in the full [[URL]] for the page you want to link to. If you want to make a link to [[Google]], all you need to do is type:
+
:<tt>http://www.google.com/</tt>
+
The wiki will automatically treat this text as a link (as has been done with the URL above) and will display the raw web address, including the "<nowiki>http://</nowiki>" part.
+
  
External reference links should often go in an External Links/References section at the bottom of a page.
+
Once it's ready, try:
 +
<nowiki>"mw2html.py http://172.16.16.134/wiki/ out -f"</nowiki>
  
===Examples:===
+
Note: you may have a problem becausee it doesn't seem to use the login cookie cached for the browser so mw2html.py is an anonymous user so it only gets logon pages for pages that anonymous users don't have permission to view.
  
Internal links: <nowiki>[[Main Page]]</nowiki> = [[Main_Page|Main Page]].
+
'''PDF Export'''
 
+
Named Internal links: <nowiki>[[Rules | rules for editing]]</nowiki> = [[Rules | rules for editing]].
+
  
Contracted External links: <nowiki>[http://www.google.com/]</nowiki> = [http://www.google.com/].  
+
Combining articles into a single PDF for printing.
 
+
It needs [http://www.htmldoc.org/ 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.
Named External links: <nowiki>[http://www.google.com/ Google Home]</nowiki> = [http://www.google.com/ Google Home].
+
 
+
Explicit External links: <nowiki>“visit http://www.google.com/ now‿</nowiki> = “visit http://www.google.com/ now‿.
+
 
   
 
   
Using link anchors (<a name="..."> in HTML):
+
The coding is very simple and works like this: (we'll call this page "Test Print")
*Creating anchors. An anchor is created automatically for each section of a page. You can create additional anchors by putting an id attribute on any HTML tag understood by MediaWiki. Example: <nowiki><div id="anchor">Text with anchor</div></nowiki> = <div id="anchor">Text with anchor</div>
+
:Note, that neither <a name="anchor">, nor <a id="anchor"> will work.
+
*Linking to an anchor. You can link to an anchor on a page using this syntax: <nowiki>[[In-House Style#Commonly used names|Commonly used names]]</nowiki> = [[In-House Style#Commonly used names|Commonly used names]]. For anchors on current page you can use <nowiki>[[#anchor|anchor]]</nowiki> = [[#anchor|anchor]].
+
  
 +
Put articles that will appear in sequence in curly braces:
 +
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
  
=Lists=
+
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:
==Bullet points==
+
You can also indent using ''bullets'', usually used for lists. To insert a bullet, use an asterisk (<tt>*</tt>). Similar to indentation, more asterisks in front of a paragraph means more indentation.
+
 
+
A brief example:
+
:<tt><nowiki>*</nowiki>First list item</tt>
+
:<tt><nowiki>*</nowiki>Second list item</tt>
+
:<tt><nowiki>**</nowiki>Sub-list item under second</tt>
+
:<tt><nowiki>*</nowiki>Third list item</tt>
+
 
+
Which is shown as:
+
:*First list item
+
:*Second list item
+
:**Sub-list item under second
+
:*Third list item
+
fourth list items
+
 
+
==Numbered items==
+
You can also create numbered lists. For this, use the [[number sign]] or hash symbol (<tt>#</tt>). This is usually used for polls and voting. Again, you can affect the indent of the number by the number of <tt>#</tt>'s you use.
+
 
+
Example:
+
:<tt><nowiki>#</nowiki>First item</tt>
+
:<tt><nowiki>#</nowiki>Second item</tt>
+
:<tt><nowiki>##</nowiki>Sub-item under second item</tt>
+
:<tt><nowiki>#</nowiki>Third item</tt>
+
 
+
Shows up as:
+
:#First item
+
:#Second item
+
:##Sub-item under second item
+
:#Third item
+
 
+
=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==
+
<nowiki>{| </nowiki>
+
 
+
<nowiki>| Cell 1, row 1 </nowiki>
+
 
+
<nowiki>| Cell 2, row 1 </nowiki>
+
 
+
<nowiki>|- </nowiki>
+
 
   
 
   
<nowiki>| Cell 1, row 2 </nowiki>
+
[http://172.16.16.134/wiki/PrintArticles.php/Test_Print Print these articles]
  
<nowiki>| Cell 2, row 2 </nowiki>
+
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:
  
<nowiki>|}</nowiki>
+
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
  
generate
+
Print these articles
  
{|
 
| Cell 1, row 1
 
| Cell 2, row 1
 
|-
 
| Cell 1, row 2
 
| Cell 2, row 2
 
|}
 
  
 +
to this:
  
 +
{Index_of_Work_Items | Feature_Proposals_Index | Index_of_Trend_Reports}
  
+
Print these articles
  
 +
Creating: (Index_of_Work_Items)
  
=Term with indented definition:=
+
Creating: (Feature_Proposals_Index)
  
<nowiki>;Term:Definition (indented)</nowiki>
+
Creating: (Index_of_Trend_Reports)
  
<nowiki>;;Term (indented):Definition (indented two levels)</nowiki>
+
[[Test Print]]
  
<nowiki>;;;Term (indented twice):Definition (indented to third level)</nowiki>
+
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
  
...which looks like:
+
==See Also==
 +
The IHE Wiki is built on MediaWiki software. The [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] is an excellent reference.
  
;Term:Definition (indented)
+
[http://meta.wikimedia.org/wiki/MediaWiki MediaWiki] and [http://en.wikipedia.org/wiki/Main_Page Wikipedia, the free encyclopedia] provide more information and examples of using MediaWiki.
;;Term (indented):Definition (indented two levels)
+
;;;Term (indented twice):Definition (indented to third level)
+
  
 +
[http://news.zdnet.com/2036-2_22-5815948.html Wiki Introduction] provides a short video outlining the use of Wiki's for collaboration
  
 +
[http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list] explains the MediaWiki config variables.
  
=Miscellaneous Rules=
+
[http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ] answers most questions about managing and using MediaWiki.
*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.
+
 
+
=Document structure=
+
 
+
 
+
[[Category:English Documentation]]
+

Latest revision as of 14:54, 10 March 2014

Wiki Map describes the high level layout of this wiki.

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.

Browse the How To's and the rest of this help page.



How to edit

Wiki pages are mostly plain text with a few basic formatting characters. If you're nervous about formatting, just type plain text and leave a blank line to separate paragraphs.

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.

Many types of pages (e.g. specific Domains, specific Committees) have templates you can copy/paste when creating new pages.

If you want a safe place to practice editing, feel free to play in the Sandbox page.

Use Templates for creating typical pages.

How to write

Writing a web page is different than writing a document.

These links provide some useful insight.

Text Conventions

<These are just provisional and should be discussed>

Use bold text to emphasize topics.

Use <italic text in angle brackets> for instructions to editors, i.e. text that should be replaced and explains what goes there, such as in a template

Use <bold italic text in angle brackets> when adding in-line comments about the contents of a page.

How to use MediaWiki

The links that are always available on the left side and across the top of the page provide a lot of useful features.

Recent Changes / History

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.

You can also see past versions from the History tab on each page.

Watch / Watchlist

The My watchlist link at the top is a filtered list that only shows changes to pages you have flagged by clicking the Watch tab at the top of each page.

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.

Printable Version

The Printable Version link on the left generates a version of the current page more suitable for printing from your browser.

Discussions

Each page has a Discussion tab at the top. If you feel it useful/necessary, explain the purpose of the page or the rationale of it's structure here.

If you are about to make a major change to a page, check the Discussion page to make sure you aren't misunderstanding the page. If you are going ahead with a major change, consider documenting your rationale.

User Page

Click on a user name (yours appears up at the top, others appear on history pages, etc) to get to their personal page. Also at the top is a my talk link which takes you to the Discussion page associated with your user page. Other users can leave you messages there. You will be automatically notified when you log in if someone has updated your discussion/talk page.

Consider this template when creating your User Page.

Special Pages

<Need to explain the really handy pages under Special Pages>

Categories

You can categorize pages by adding one or more category tags to the text. Adding a tag creates a link at the bottom of the article which take you to the list of all pages in that category, which makes it easy to browse related articles.

For example, add one of these to the bottom of a page:

 [[Category:Actor]]
 [[Category:Agenda]]
 [[Category:Minutes]]
 [[Category:Profiles]]
 [[Category:Templates]] 

In addtion, you can categorize each page based on its domain abbreviation:

 [[Category:PCD]]

Add as many tags as you like, so your page will be found in as many appropriate category listings as makes sense.

Finally, you may want your category sorted differently. The following tag puts your page on the Profiles list, but sorted using the "SortMeHere" tag:

 [[Category:Profiles | SortMeHere]]

Tips & Tricks

Quasi-Back Button

If you have done several edits, when you use the browser "Back" button you will have to go back many times to get to the page you came from.

As an alternative that takes two clicks, you can click on "What links here" in the Toolbox on the left side of the Wiki page. The page you came from will be listed there an you can click on it.

Text Size

To change the font size from the normal size to larger or smaller use:

<big> text </big>
<small> text </small>

Text Color

To change the color of the font being displayed use:

<font color=red> text </font>

Line Formatting

To force a hard Carriage-Return/Line-feed in the displayed document, either leave a blank line, or use:

<br />

To center a text line, or all text between start HTML Tag and end HTML tag, use:

<center>text</center>

Quoting Text

To quote text without applying the wiki formatting rules use:

<nowiki> text </nowiki>

Within a nowiki section, only HTML-quoting of special characters (<>&) will occur--no other formatting rules will be applied.

Embedding Images/Graphics/Documents

First upload the jpg using the Upload File link on the left. Then put a link to the jpg at the place you want the image to appear using the following format:

[[Image:NameOfYourFile.jpg]]

You can also embed links to files such as:

[[:Media:NameOfYourFile.doc | link text]]
Term (bolded term)
Definition (with indented definition)

is accomplished by:

;Term (bolded term):Definition (with indented definition)

Using Templates

There are templates for some typical types of pages. A page often has a link in the See Also section to the template it was created from.

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.

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
  • <still need to 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:

Task Lists

The MediaWikiTasks plugin supports managing task lists.

Timelines

The EasyTimelines plugin supports displaying annotated timelines.

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"

Note: you may have a problem becausee it doesn't seem to use the login cookie cached for the browser so mw2html.py is an anonymous user so it only gets logon pages for pages that anonymous users don't have permission to view.

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:

Print these articles

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)

Test Print

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

See Also

The IHE Wiki is built on MediaWiki software. The MediaWiki User's Guide is an excellent reference.

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

Configuration settings list explains the MediaWiki config variables.

MediaWiki FAQ answers most questions about managing and using MediaWiki.