Difference between revisions of "Dokuwiki on NCF organizational websites"
(spelling) |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This | This article shows how you can set up and use the Dokuwiki wiki system on an [http://www.ncf.ca/ncf/register/orgform.html NCF organizational account] web site. | ||
=== Why Dokuwiki === | === Why Dokuwiki === | ||
Most people are familiar with the output of a wiki because of Wikipedia, though the understanding of how a wiki is useful | Most people are familiar with the output of a wiki because of Wikipedia, though the understanding of how a wiki is useful is less common. | ||
Essentially a wiki is a structured web-site that allows many users to view the content and (generally) fewer users to write or edit the content. The structure simplifies the process of adding and editing content. NCF uses the same software as [https://en.wikipedia.org Wikipedia], called [https://www.mediawiki.org/wiki/MediaWiki Mediawiki], for the help database. | Essentially a wiki is a structured web-site that allows many users to view the content and (generally) fewer users to write or edit the content. The structure simplifies the process of adding and editing content. NCF uses the same software as [https://en.wikipedia.org Wikipedia], called [https://www.mediawiki.org/wiki/MediaWiki Mediawiki], for the help database. | ||
| Line 11: | Line 11: | ||
* there is fairly simple formatting or '''markup''' to provide for some styling | * there is fairly simple formatting or '''markup''' to provide for some styling | ||
* there are many plugins to provide special features such as maths, music, etc. | * there are many plugins to provide special features such as maths, music, etc. | ||
* there are a number of designs and templates to change the appearance even if the content is unchanged. | * there are a number of designs and templates to change the appearance, even if the content is unchanged. | ||
Dokuwiki is a wiki system that has some particular merits for NCF users: | Dokuwiki is a wiki system that has some particular merits for NCF users: | ||
| Line 17: | Line 17: | ||
* unlike Mediawiki, Dokuwiki does not need an SQL database to store content | * unlike Mediawiki, Dokuwiki does not need an SQL database to store content | ||
* all text is stored in plain text files | * all text is stored in plain text files | ||
* the entire directory of software and content may be backed up and, for the most part, put on a new system to migrate the wiki or recover it if a server fails. | * the entire directory of software and content may be backed up and, for the most part, put on a new system to migrate the wiki, or recover it if a server fails. | ||
=== Basic information needed for NCF === | === Basic information needed for NCF === | ||
| Line 33: | Line 33: | ||
** you use yy999-123 and the same password for the ftp client. | ** you use yy999-123 and the same password for the ftp client. | ||
** There are a number of FTP clients for different platforms | ** There are a number of FTP clients for different platforms | ||
*** Linux: [http://gftp.seul.org/ gftp] | *** Linux: [http://gftp.seul.org/ gftp] | ||
*** Mac: [https://cyberduck.io/ CyberDuck] | *** Mac: [https://cyberduck.io/ CyberDuck] | ||
*** [https://filezilla-project.org/ Filezilla] | *** All platforms: [https://filezilla-project.org/ Filezilla] | ||
=== Preparation for the wiki === | === Preparation for the wiki === | ||
| Line 53: | Line 52: | ||
<nowiki><body></nowiki><br> | <nowiki><body></nowiki><br> | ||
<nowiki><H1>Absolutely Marvelous Organization</H1></nowiki><br> | <nowiki><H1>Absolutely Marvelous Organization</H1></nowiki><br> | ||
<nowiki><p>AMO is the most friendly Ottawa social society</p></nowiki><br> | <nowiki><p>AMO is the most friendly Ottawa social society</p></nowiki><br> | ||
<nowiki><p>This website is intended to serve its members and staff.</p></nowiki><br> | <nowiki><p>This website is intended to serve its members and staff.</p></nowiki><br> | ||
<nowiki><p>There is a repository of information on AMO at <a href="http://myorg.ncf.ca/wiki/">myorg.ncf.ca/wiki/</a></p></nowiki><br> | <nowiki><p>There is a repository of information on AMO at <a href="http://myorg.ncf.ca/wiki/">myorg.ncf.ca/wiki/</a></p></nowiki><br> | ||
<nowiki><p>At this time, logins may be required for part of the content.</p></nowiki><br> | <nowiki><p>At this time, logins may be required for part of the content.</p></nowiki><br> | ||
<nowiki></body></nowiki><br> | <nowiki></body></nowiki><br> | ||
<nowiki></html></nowiki><br> | <nowiki></html></nowiki><br> | ||
| Line 80: | Line 74: | ||
Dokuwiki is written in the php computer language. NCF organizational members have php available in their website locations. Thus you simply point a web-browser (from your local machine) to: | Dokuwiki is written in the php computer language. NCF organizational members have php available in their website locations. Thus you simply point a web-browser (from your local machine) to: | ||
* | * <nowiki>http://myorg.ncf.ca/wiki/install.php</nowiki> | ||
This will present a form that allows the wiki to be set up. Make sure you answer all the mandatory questions. You can then start the wiki. | This will present a form that allows the wiki to be set up. Make sure you answer all the mandatory questions. You can then start the wiki. | ||
| Line 92: | Line 86: | ||
When you get into the wiki, you should log in, using the Dokuwiki administrator name and password. Then you can search for a page such as ''Mainpage'' which will not exist, but you can choose to create it, then use the editing functions to provide content.<!-- ??more?? --> | When you get into the wiki, you should log in, using the Dokuwiki administrator name and password. Then you can search for a page such as ''Mainpage'' which will not exist, but you can choose to create it, then use the editing functions to provide content.<!-- ??more?? --> | ||
==External links== | |||
*[https://www.dokuwiki.org/dokuwiki# Dokuwiki] | |||
[[Category:Web space]] | [[Category:Web space]] | ||
Latest revision as of 17:08, 5 January 2017
This article shows how you can set up and use the Dokuwiki wiki system on an NCF organizational account web site.
Why Dokuwiki
Most people are familiar with the output of a wiki because of Wikipedia, though the understanding of how a wiki is useful is less common.
Essentially a wiki is a structured web-site that allows many users to view the content and (generally) fewer users to write or edit the content. The structure simplifies the process of adding and editing content. NCF uses the same software as Wikipedia, called Mediawiki, for the help database.
Wikis share the following features:
- there is fairly simple formatting or markup to provide for some styling
- there are many plugins to provide special features such as maths, music, etc.
- there are a number of designs and templates to change the appearance, even if the content is unchanged.
Dokuwiki is a wiki system that has some particular merits for NCF users:
- unlike Mediawiki, Dokuwiki does not need an SQL database to store content
- all text is stored in plain text files
- the entire directory of software and content may be backed up and, for the most part, put on a new system to migrate the wiki, or recover it if a server fails.
Basic information needed for NCF
Before you can begin, you need an organizational account for your organization, which we will call myorg. We will assume the username is yy999 with password yy999pw. The NCF administrator will give you:
- The FTP login ID for myorg.ncf.ca as something like "yy999-123"
- While not needed for Dokuwiki, you may also get database configuration info such as
- Database host: localhost
- Database user: e.g., yy999-321
- Database password: e.g. T8234yuyp
- Database name: myorg_ncf_ca
- NCF keeps things pretty straightforward, and makes your website accessible via the URL myorg.ncf.ca. You can load content there with either the web file manager using your browser, or else with an ftp client.
Preparation for the wiki
It is recommended that the organization website have an index.html file and that the wiki be in a subdirectory. This allows for more flexibility in presenting information to site visitors. You may choose to have a completely closed wiki where the content is only visible to users who can log in using a username and password. These usernames and passwords are specific to the wiki. They are NOT related to the NCF usernames and passwords.
Here is a sample index.html file:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>CCC21</title>
</head>
<body>
<H1>Absolutely Marvelous Organization</H1>
<p>AMO is the most friendly Ottawa social society</p>
<p>This website is intended to serve its members and staff.</p>
<p>There is a repository of information on AMO at <a href="http://myorg.ncf.ca/wiki/">myorg.ncf.ca/wiki/</a></p>
<p>At this time, logins may be required for part of the content.</p>
</body>
</html>
Setting up a Dokuwiki
Note that there are other sources for this or related information, for example this tutorial.
Download the software into the website location
- Download the latest stable Dokuwiki software from the website to your local computer. This will be a tarball or .tgz file.
- Unpack the tarball on your local computer.
- Rename the directory in which the software unpacks to the name of the directory you wish for your wiki, e.g., wiki or ourwiki.
- Using your ftp client, copy this whole directory to the NCF file location of your website. This will be the directory where the index.html file is located.
Run the installer
Dokuwiki is written in the php computer language. NCF organizational members have php available in their website locations. Thus you simply point a web-browser (from your local machine) to:
- http://myorg.ncf.ca/wiki/install.php
This will present a form that allows the wiki to be set up. Make sure you answer all the mandatory questions. You can then start the wiki.
Possible problems
Sometimes the wiki requires permissions to be set. This can be done using some of the ftp clients.
Adding content
When you get into the wiki, you should log in, using the Dokuwiki administrator name and password. Then you can search for a page such as Mainpage which will not exist, but you can choose to create it, then use the editing functions to provide content.