Problems
What about spammers and malicious hackers? This is surely a problem, but the success of Wikipedia [2] tells us that wikis work anyway. Every day thousands of pages in the Wikipedia are deleted or flooded with rubbish. It works nevertheless.
A wiki keeps track of all changes. That means a good guy can restore a destroyed page with a single click. Nevertheless the problem is a large one, and almost all wikis nowadays require contributors to log in before editing. That makes it much harder for our beloved spammers to flood a wiki with rubbish.
In the APL Wiki you can freely add attachments, but this might not last. (Many other wikis are flooded with porn attachments.)
Why an APL Wiki?
A wiki is a perfect environment to let people collaborate. Since Jsoftware Inc. introduced the J Wiki [3] it has become a valuable source of information for the J community. By the way, the J Wiki was a model for the APL Wiki. One of the administrators of the J Wiki, Chris Burke, helped me to install and configure MoinMoin – thank you very much Chris!
My hope is that the APL Wiki becomes a recognised source for valuable information about APL: articles, examples, tasks, papers, solutions, libraries, frameworks…
Getting Help
Especially for beginners it is important to get a helping hand with problems. The APL Wiki uses MoinMoin [4], which offers a large number of help pages. The names of all help pages start with HelpOn. So entering helpon in the search box and pressing Enter returns a list of all the help pages.
Please note that pressing Enter triggers a title search. Clicking on the Text button has MoinMoin perform a full text search across all pages. Understandably, this type of search can take a while.
Unicode and Fonts
The APL Wiki is encoded in UTF-8. That means that all modern browsers should display APL characters. As usual, Internet Explorer might cause a problem. The behaviour of IE5.5 and IE6 is unpredictable, as is version 7; but in general version 7 is much better. However, on some machines even IE7 does not display UTF-8 correctly, and nobody understands why.
Strictly speaking, you do not need a particular font: any Unicode font will do. The APL Wiki will use the APL385 Unicode font [5] if it is installed on your machine, otherwise Courier is used. That should still result in APL symbols, since nowadays your Courier is likely to be a Unicode font with all the APL symbols. But few fonts have been designed to display APL attractively: you will see the best results by downloading and installing the APL385 Unicode font file.
Most of the advice on Vector’s help page “Displaying Vector pages” applies to the APL Wiki.
APL Code: Edit, Copy, Paste
Why is Unicode so important? Because you can copy and paste code between platforms supporting UTF-8! For example, you can copy APL code from an edit window in Dyalog APL or APLX and insert it into an article on the APL Wiki. Put {{{ and }}} around it and you are ready.
That also works the other way around: copy APL code from the APL Wiki, insert into the session of Dyalog or APLX and it will run.
Google Mail optionally supports UTF-8, too. So you can exchange APL code between sessions, edit windows, the APL Wiki and Google Mail.
If you have installed Dyalog APL/W on your machine, you can use its Input Method Editor to edit APL code in the APL Wiki. From within Microsoft Word or the MoinMoin article editor you can change the keyboard layout to APL and then type APL just as you would in Dyalog.
The Test Wiki
Of course you should get some experience before starting serious contributions to any wiki. For that, many wikis provide a sandbox. This is a small wiki, basically a copy of the master wiki, where everybody can play around without danger of destroying something valuable. The APL test wiki address is: http://aplteam2.com/testwiki/
Note that this address is very different from the APL Wiki address: http://aplwiki.aplteam.com
Certain pages are protected to ensure an appropriate structure for the root of the wiki, but otherwise pages are editable, and you can add any new pages you think are needed.
Creating an Account
Even in the test wiki you need to create an account first. (Otherwise the test wiki would soon become a porn site.) It is recommended you use CamelCase for your username: e.g., JohnDoe rather than John Doe. This way you can easily add links pointing to your internal “home page”. (You might not wish to create such a page right now but there is a good chance you will later.)
Note that passwords and usernames are case sensitive.
In case of a forgotten password you can ask the wiki to send you an email with your password hash, which MoinMoin will accept instead. Then it would be smart to change your password! (MoinMoin does not save passwords but hashes, so it can tell you only the hash. A hash can be generated from a password, but there is no way to recover a password from its hash.)
Editing
To edit a website, normally you need to know HTML. Although HTML is simple enough, wikis make editing even easier with an extremely simplified markup. For example, to mark up a top-level header one would say:
= Heading =
A second-level header would look like this:
== Subheading ==
Here you see the markup for an unordered list:
* a topic
* another topic
An example for an ordered list:
1. First item
1. Second item
It does not matter which number is used – any number will do. Note that for list definitions the first character on a line must be a blank.
Finally an example for a bold word:
This is a '''bold''' word
Besides lists and headers, you need to know how to create a link. In general, there are two different kinds of links: internal and external. The easiest way to create an internal link is to use CamelCase syntax. Words written in CamelCase are automatically created as an internal link. There are two possible problems:
1. Sometimes you want to use CamelCase without creating a link. For example, mentioning the most popular version-control software, SubVersion, results in an internal link. Fortunately, there is an easy way to tell MoinMoin that you do not want such a link: !SubVersion will do the trick.
2. Sometimes you want a link to something like DyalogAPL. That does not work, but DyalogApl looks ugly. In those cases you can use some of the more sophisticated markup to create a link. Refer to HelpOnLinking.
External links can be created with expressions like this:
[http://www.dyalog.com Dyalog APL Version 11]
Dyalog APL Version 11 then becomes a hyperlink.
Since we are talking about an APL Wiki, we need to know how to enter code. Everything between {{{ and }}} gets a box with a distinctive background colour. (All whitespace is preserved.) The syntax we’ve discussed so far should already be good enough to start your career as an author on the APL Wiki. Don’t hesitate!
Share with your friends: |