Wiki help files in English (I did some editing for grammar etc)

This commit is contained in:
moodler 2004-06-02 12:43:21 +00:00
parent 7b38bfa6fd
commit fd5d3da168
13 changed files with 237 additions and 0 deletions

View file

@ -0,0 +1,3 @@
<P ALIGN=CENTER><B>Check Links</B></P>
<P>This tool checks all http:// links for availability, and afterwards resaves the
wiki page with the dead links marked for easier editing.</P>

View file

@ -0,0 +1,12 @@
<P ALIGN=CENTER><B>Allow Binary Files</B></P>
<P>If you allow binary content (such as images), you have two possibilities:<BR>
<OL>
<LI>You can upload and use images on wiki-pages. When editing a page, an upload form will be displayed
for uploading images. After a successful upload, an image code is displayed that you can embed in
your pages using square brackets. For example: [internal://myimage.gif].</LI>
<LI>You can attach files to a Wiki Page which can be displayed by the <i>attachments</i> action.
The size is limited to the setting made in Moodle.</LI>
</OL>
</P>

View file

@ -0,0 +1,13 @@
<P ALIGN=CENTER><B>HTML Mode</B></P>
<P>You have the following possibilities:
<dl>
<dt>No HTML</dt>
<dd>Escapes all HTML-Tags. Formatting is done through the WikiWords. Filters work in this Mode.</dd>
<dt>Safe HTML</dt>
<dd>Some Tags are allowed and are displayed. There are no filters active which need tags in this mode !</dd>
<dt>HTML only</dt>
<dd>No WikiWords, just HTML. This option allows the use of the HTML-Editor.</dd>
</dl>
</P>

View file

@ -0,0 +1 @@

View file

@ -0,0 +1,15 @@
<P><IMG VALIGN=absmiddle SRC="<?php echo $CFG->wwwroot?>/mod/wiki/icon.gif">&nbsp;<B>Wikis</B></P>
<UL>
<P>A Wiki enables documents to be authored collectively in a simple markup language using a web browser.</P>
<P>"Wiki wiki" means "super fast" in the Hawaiian language, and it is the speed of creating and
updating pages that is one of the defining aspects of wiki technology. Generally, there is no
prior review before modifications are accepted, and most wikis are open to the general
public or at least to all persons who also have access to the wiki server.</P>
<P>The Moodle Wiki module enables participants to work together on web pages to add,
expand and change the content. Old versions are never deleted and can be restored.</P>
<P>This module is based on <a href="http://erfurtwiki.sourceforge.net" target=_new>Erfurt Wiki</a>.</P>
</UL>

View file

@ -0,0 +1,3 @@
<P ALIGN=CENTER><B>Remove Pages</B></P>
<P>This function allows you to remove wiki pages. A quick check is done and pages with errors are shown.</P>
<P>Please take care and think twice before removing a page. Usually it is not necessary.</P>

View file

@ -0,0 +1,5 @@
<P ALIGN=CENTER><B>Author for reverting mass changes</B></P>
<P>
This must be a fixed string (you cannot use * or regex), at
best use the attackers` IP address or host name.
</P>

View file

@ -0,0 +1,4 @@
<P ALIGN=CENTER><B>Revert Pages</B></P>
<P>If someone makes a mess of many pages in your Wiki, you may want to automatically revert those changes by
deleting all page versions that carry a certain string in the {author} field (usually the IP address or host name)</P>

View file

@ -0,0 +1,13 @@
<P ALIGN=CENTER><B>Set Page Flags</B></P>
<P>Flags are assigned to a wiki page and allow to change the type or behavior.</P>
<P>Flag description:</P>
<table border="1" width="100%"><tbody>
<tr><td valign="top" width="25%">TXT</td><td>The page contains text.</td></tr>
<tr><td valign="top" width="25%">BIN</td><td>The page contains binary data.</td></tr>
<tr><td valign="top" width="25%">OFF</td><td>The page is disabled.</td></tr>
<tr><td valign="top" width="25%">HTM</td><td>Allow HTML for this page (the general Wiki setting precedes this flag).</td></tr>
<tr><td valign="top" width="25%">RO</td><td>Read Only.</td></tr>
<tr><td valign="top" width="25%">WR</td><td>Writeable.</td></tr>
</table>

View file

@ -0,0 +1,3 @@
<P ALIGN=CENTER><B>Strip Pages</B></P>
<P>This function purges old versions of all pages stored in the database and just keeps the newest versions.</P>

11
lang/en/help/wiki/wikiname.html Executable file
View file

@ -0,0 +1,11 @@
<P ALIGN=CENTER><B>Initial Page Name for wiki</B></P>
<P>
You can select a name to give to the initial wiki page here. This name will become the first
page of the wiki whenever it is viewed from the course. If you do not specify a name in wiki
'camel case' (mixed upper and lower case words, compressed together - e.g. 'WikiName'), then
whatever you enter will be forced into camel case.<br><br>
If you leave this field blank, the initial page name will be the wiki name, unless you select
a page in the 'initial page' field.
</P>

View file

@ -0,0 +1,39 @@
<P ALIGN=CENTER><B>Allow students to contribute to the wiki</B></P>
<P>
<UL>
<li>A teacher can always edit every wiki in his course</li>
<li>There are three wiki -types: Teacher, Course/Group, Student</li>
<li>The Activity has the Moodle-Group states: &quot;No Groups&quot; &quot;Separate Groups&quot; and &quot;Visible Groups&quot;</li>
<li>The same initial Content is filled in for all groups</li>
</UL>
There is now a matrice:
<table border="1" width="100%"><tbody>
<tr>
<th valign="top" width="25%"></th>
<th valign="top" width="25%">No Groups</th>
<th valign="top" width="25%">Separate Groups</th>
<th valign="top" width="25%">Visible Groups</th>
</tr>
<tr>
<th valign="top" width="25%">Teacher</th>
<td valign="top" width="25%">Teacher creates and changes the wiki. Students can read the contents.</td>
<td valign="top" width="25%">There is a wiki for every group which just the teacher can change. Every student just sees the wiki of his group.</td>
<td valign="top" width="25%">There is a Wik for every group which just the teacher can change. The students can see all wikis, choseable by a Drop-Down box which contains all groups.</td>
</tr>
<tr>
<th valign="top" width="25%">Course/Group</th>
<td valign="top" width="25%">Teacher and user can create and change the wiki.</td>
<td valign="top" width="25%">Students can change and see the wiki of their own group.</td>
<td valign="top" width="25%">Students can change the wiki of their own group. They can see all wikis, choseable by a Drop-Down box which contains all groups.</td>
</tr>
<tr>
<th valign="top" width="25%">Student</th>
<td valign="top" width="25%">Every student sees and can change his own wiki.</td>
<td valign="top" width="25%">Every student can change his own wiki, and sees all other wikis of the students in his group, choseable by a Drop-Down box which contains all students of his group.</td>
<td valign="top" width="25%">Every student can change his own wiki, and sees all other wikis, choseable by a Drop-Down box which contains all students.</td>
</tr></tbody>
</table>
</P>

View file

@ -0,0 +1,115 @@
<P ALIGN=CENTER><B>Wiki Usage</B></P>
<p>
<br>
Wiki is a platform for working together on constructing web pages. The principles are simple.
<br><br>
<ul>
<li>A text is written and saved.</li>
<li>Later, another person may read that text and think of some additions or
corrections that could be made. They choose "Edit" and make their changes to the page. </li>
<li>After saving their new version, it is available globally.</li><br> <br>
</ul>
With a wiki, it is also easily possible to add a page or link to existing pages.
<br><br>
<ul>
<li>A link is created by a WikiWord. This is one word with at least two capital letters. If a page with this name already exist, it will be linked automatically, if not, it will be displayed with a question mark.</li>
<li>Clicking on this question mark, will start a new blank page with that name, ready to edit.</li>
</ul>
<br><br>
<P ALIGN=CENTER><B><br>
Wiki formatting rules</B></P>
<p>
<h4> Paragraphs</h4>
<ul>
<li> separate paragraphs inside the text with empty lines</li>
<li> use three percent signs %%% to enforce a line break</li>
<li> if you prepend text with spaces or tabs it will get indented </li>
</ul>
<h4> !! Headlines</h4>
<ul type="circle">
<li> use an exclamation mark ! at the beginning of a line to create a small headline</li>
<li> !! for medium</li>
<li> !!! for large headlines </li>
</ul>
<h4>Text style</h4>
<ul>
<li> if you want to <em>emphasize text</em> enclose it in two single-quotes '' (usually looks italic)</li>
<li> <strong>text gets bold</strong> with two underscores __ (or if enclosed with two asterisks **)</li>
<li> to make <big>text big</big> enclose it in hash characters ##</li>
<li> you can get <small> smaller text </small> using "µµ" likewise</li>
<li> a <tt>typewrite like font</tt> will be used if you enclose text in two equal == signs </li>
</ul>
<h4>Lists</h4>
<ul>
<li> start a line with an asterisk * to begin a list</li>
<li> use # instead for numerated lists
<ol>
<li> you can create sublists</li>
<li> subsequent list points should start with the same mix of * and # </li>
</ol>
</li>
</ul>
<h4> HyperLinks</h4>
<ul>
<li> just enter a WikiWord inside your text to create a new hyper link</li>
<li> enclose some words in [square brackets] to create a HyperLink inside the WikiWikiWeb which is not made up of a valid WikiWord</li>
<li> any valid internet address (starting with http:/) like http://www.example.com/ inside the text will be made clickable automagically</li>
<li> enclose a www address or a WikiLink inside square brackets and assign it a neat title using quotation marks or the | character
<ul>
<li> [title | http://example.com]</li>
<li> [WikiWord "title"] or ["title for" WikiLink] </li>
</ul>
</li>
<li> if you don't want a WikiWord or a http://www-address (or [anything] inside square brackets) to become a HyperLink then just prepend it with a exclamation mark or a tilde
<ul>
<li> !NoHyperLink, ~NoHyperLink</li>
<li> ![no hyperlink], !http://nolink.org/ </li>
</ul>
</li>
</ul>
<h4> Tables with |</h4>
| just enclose | things with the dash | character | <br>
| to build a | table structure | <br>
| browsers usually | leave out the missing | cells | <br>
<p>
Please always put an empty line before and after a table, so it stands out from other text in its own paragraph.
</p>
<h4> Pictures</h4>
<ul>
<li> to include an image into a page enclose its absolute www-address in square brackets, like [http://www.example.com/pics/image.png] </li>
<li> alternatively you could use the image uploading function.</li>
</ul>
<h4>Further readings</h4>
There are more possibilities for Wiki mark-up. Please consult the <a href="http://erfurtwiki.sourceforge.net" target=_new>Erfurt Wiki Homepage</a> for more information.