Help:Contents: Difference between revisions
| Line 301: | Line 301: | ||
via http and move the entire mediawiki folder here. When I did it, it was: | via http and move the entire mediawiki folder here. When I did it, it was: | ||
::/var/www/html/ | ::/var/www/html/ | ||
:*Once the folder is there, browse http://my_ip_address/mediawiki. The installation script should start and you can now fill in the boxes, | :*Once the folder is there, browse <nowiki>http://my_ip_address/mediawiki</nowiki>. The installation script should start and you can now fill in the boxes, | ||
initializing the site and the database which will store all the site data. | initializing the site and the database which will store all the site data. | ||
Revision as of 23:55, 27 June 2005
Basic Editing
Text Editing
The simplest page modifications for this site are editing the text of a page. The text of a page can be edited all at once, or more practically section by section.
Editing a section:
- Click the adjacent edit tab at the top of the desired section.
- The browser now displays a large text box in the center of the page. Inside this box contains all of the text of the section.
- Note: There are several formatting conventions to be considered when adding text. These affect the margins, layout, bullets,
section organisation, etc. See the below section about Text Formatting for details.
- Once the text has been modified, select 'Save Page' below the text window.
- The change are now saved and the new, modified version of this page will appear.
Be careful whenever making any changes, because once the changes are saved, this becomes the new page. Therefore it is possible to delete entire sections. (For recovery of old page versions, see the Recent Changes page).
Editing an entire page
- Similar to above, but select the 'edit' tab at the top of the page. Now, the text for the entire page appears in the text editing
window.
- This is useful for changing the arrangement and ordering of sections but is not recommended for specific text editing.
Especially here, be careful when editing because the entire page could be deleted.
Text Formatting
If you're familiar with HTML conventions, you can apply most of these on a wiki page, however wiki has many of its own conventions. The following table lists the text formatting operations applicable to this site.
| What appears on the Page | What you type |
|---|---|
|
Section Headers: This can't really be demonstrated within a table, but click the edit tab for various sections to see examples of sections. |
= Major Section= ==Section== ===Sub-Section=== ====Sub-Sub-Section==== |
| Newline:
Typing on the next line will not make a new line. But leaving one line empty does start a new line.
To start a new line without making a new paragraph |
Typing on the next line will not make a new line. But leaving one line empty does start a new line. To start a new line without making a new paragraph <br> Now we have a new line here. |
|
Lists
Starting a regular line like this ends the list.
|
*Lists are started like this. **They can also have sub lists ***and sub-sub lists. Starting a regular line like this ends the list. *But you can break <BR> lines <br> within a list <br> like this. *Then start a new line. |
|
Numbered Lists:
The end of the list.
|
#Numbered lists can be created automatically. #New number here ##I'm a number within a number. ##Me too. #Back to the original list. The end of the list. #Now here's a new list. |
|
Indenting
No indent here!
|
:Starting a line with a colon ::or several colons, you can indent the line. No indent here! :::::I'm super indented. :*Indenting, as well as bullets, and numbered lists can ::be combined. :#I'm number one :#*I'm almost one :#I'm only number two :( |
Starting every line with a space means that the text won't be formatted and should appear as typed. But be careful, lines no longer wrap automatically. *This can be useful for preformatted text but also, is nice for code because it makes this nice box. Another way to make text within this box is to use <pre> and </pre> We're inside a box. *Ya, isn't this cool. |
Starting every line with a
space means that the text won't be formatted
and should appear as typed. But be careful, lines no
longer wrap automatically.
*This can be useful for preformatted text
but also, is nice for code because it makes this nice box.
Another way to make text within this box is to use <pre> and </pre> <nowiki> <pre> We're inside a box. *Ya, isn't this cool.</nowiki> |
Tables
Tables, like the one above are very useful for organising information, or for specifying the layout of a page - placing text and images in certain locations.
- (Click edit of the table above as an example)
- A table begins and ends with <table> Table code </table>.
- A row begins and ends with <tr> Row code </tr>.
- A column begins and ends with <td> Column code </td>.
These are nested within each other: begin a table, row, column; end the column, row, table. These are nested within each other: begin a table, row, column; end the column, row, table.
- There are several options that may be set when starting a table, row, or column. The following is a list of the most useful.
- border - Sets the thickness of the border for the entire table, or can be invisible.
- ex:
border="n", (n = {0,1,2,3,etc.})
- align - sets the alignment of the table with respect to the page margins, or the text and objects within a cell.
- ex:
align="center", (or right, left).
- valign - sets the vertical alignment of the text and objects within a cell.
- ex:
valign="top", (bottom, middle).
- width, height - sets the width, height of the table and/or a column, row.
- ex:
width="90%" height="450', (size can be in number of pixels, or as a percentage).
- background - sets the background of a cell or table. This can be either a picture or a solid color.
- ex:
bgcolor="yellow"orbackground="mypicture.jpg".
Upload Help
- Once logged-on to the site, select the 'Upload file' link within the toolbox on the left side-bar.
- 'Browse' your system for the desired file, confirm its copyright compliance, and select Upload File.
- By default, a page will be created for this file with the filename as its address and, regardless of its type, will be classified as an image.
- The file is now stored in the image section of the site and can be linked to from any other page within the site, as follows.
- a) If the file is an image, then place the following code on a wiki page at the desired location of the image:
[[Image:my_favorite_image.jpg|picture_position,ie_right,left,center]]
- (The picture location is not necessary and could be left blank. See the example below.)
- b) If the file is not an image, then insert the following code where the file is to be downloaded:
- (This code should most likely be inserted into the Documents page)
[[Media:my_favorite_document.pdf| Document Link Name Displayed on Page]]
- NB. For a list of all the files available for download from the wiki site, both images and none images, go to the Special Pages link in the toolbox and then select Image list. This page lists all the uploaded files on the site and they can all be downloaded from here.
Examples
- click the adjacent 'edit' tabs to view the code for the examples.
Documents
Now let's provide a pdf document: I'm a pdf document
Images
Let's put an image of Steve here: File:Steve Boyd money.jpg
- NB. Note how a link is automatically created to the picture's actual location within the image section - click on the image itself to see.
Site Administration
Site Creation
The following explains how this wiki site was created. The intention is that in the event the site is lost, so long as the text from this page is backed-up somewhere, the site could be recreated. Also, just to complete the documentation, I have tried to outline all the steps that I took and explanations of parts that I had problems with while developing this site.
- The "wiki" interface of this site was developed by MediaWiki and this software runs in the background, on the server at all times. It
is this interface that allows users to edit pages, upload documents, and change a variety of settings, which is all stored in a database on the server.
- The database that is compatible with MediaWiki is mySQL. This is a standard database that is one of the packages included with the latest
Fedora Core for linux. This database caused several problems during the development of the first versions of the wiki site, however the version mySQL 4.1 has so far not caused any similar problems.
- It is useful to know that all the data from the site is stored on a mySQL database on the server, however there should be no need to ever
directly access this database, or try to edit or modify it directly.
- The one exception to this is for setting up the system operator (sysop) or bureaucrat privileges. (more on this later)
Install Instructions
Check out MediaWIki Installation
- Download the latest, stable version of mediawiki from wikipedia.sourcforge.
- The MediaWiki FAQs are excellent, and should provide clear and thorough instructions for downloading and installing the program.
(However here is a quick summary)
- Read the 'Install.txt' file for installation instructions and system requirements.
- The system requirements for the server (which could really be any computer set up appropriately, although preferably linux) are:
- Apache web server
- mySQL database
- PHP-mySQL package
- (If running a new version of Fedora Core, all of these can be installed as packages from the original boot disks).
- Uncompress and untar the mediawiki folder. It is advised to rename this folder something convenient, like wiki or mediawiki.
- Change the read/write access of the config directory to be readable by all. This folder contains the php script for the initial configuration.
chmod a+w config
- The next step is to browse into this folder from an internet browser. If this is run off of your linux box, you will need to find the folder open to the world
via http and move the entire mediawiki folder here. When I did it, it was:
- /var/www/html/
- Once the folder is there, browse http://my_ip_address/mediawiki. The installation script should start and you can now fill in the boxes,
initializing the site and the database which will store all the site data.
- The on-screen instructions are rather self-explanatory and after filling in and confirming the necessary information, the site should be created.
- On the new page, the instructions will say to move the 'LocalSettings.php' file into your main mediawik folder and then delete the config directory.
- Once this is done, the 'LocalSettings.php' file now becomes the default script that loads the mainpage of the wiki site.
LocalSettings.php
This becomes the most important and useful file to change the apperance and customize the wiki site. Everything else can be done through the interface of the wiki site itself. Within this file, one can change the navigation bar on the left margin, the logo appearing in the upper left corner, the name of the site, the ability to upload files, the name of the site, the contact information and address of the site administrator, among others.
- Navigation bar -
Wiki software successfully installed.
Please see documentation on customizing the interface
and the User's Guide for usage and configuration help.