APL Wiki|
Size: 2685
Comment:
|
Size: 2898
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| Providing useful information to APL programmers can be done in a number of ways. In a Wiki, there is no way to enforce people to follow particular conventions. You might think about this as an invitation to create chaos. A very different view would be that this way good things will defat the less good ones sooner or later. | Providing useful information to APL programmers can be done in a number of ways. In a Wiki, there is no way to force people to follow particular conventions. You might think about this as an invitation to create chaos. A very different view would be that this way good things will defat the less good ones sooner or later. However, here are some hints and suggestions you might find useful. == Linking == === Adding a new page === To add a new page first follow these steps: 1. Look for an appropriate page you want to put a link on. 1. Change that page by adding the link. Using !CamelCase is the easiest way to do so, but you can also use more sophisticated links; Refere to HelpOnLinking for details. 1. Click at the link you have just created. This gives you the opportunity to created a new page from scratch. |
| Line 10: | Line 22: |
| If you have created a particular page, please put a "Author: FirstnameLastname" at the end of the article if you are willing to keep an eye on the page. Write it like KaiJaeger, because this let the Wiki link automatically to your "homepage". This is another good reason to create such a homepage. | If you have created a particular page, please put a "Author: !FirstnameLastname" at the end of the article if you are willing to keep an eye on the page. Write it like KaiJaeger because this let the Wiki link automatically to your "homepage". This is another good reason to create such a homepage. |
| Line 12: | Line 24: |
| == Linking == | === Categories === |
| Line 14: | Line 26: |
| === Overview === | Adding a string "!CategorySomething" offer a link to a so-called category page. When such a page is created, a MoinMoin macro can be inserted to produce dynamically a list of pages which also contains such a link. This is very useful because new pages are automatically added to the list as soon as they become available. |
| Line 16: | Line 28: |
| Wikis do *not* contain highly sophisticated structured pages which are all anchored into a menu. This makes not much sense because thi is very hard to maintain, at least in a large Wiki. Two different methods are available in MoinMoin-driven Wikis: | You might connect a particular page to several categories if this is appropriate. This makes it easier for others to find the page. |
| Line 20: | Line 32: |
| Use the "!Mainpage/Subpage" mechanism when appropriate. That makes navigation for the user much easier. | Use the "!Mainpage/Subpage" mechanism when appropriate. An example is the three-goats-problem: On one page, the task is defined, on a second the solution explained. Both pages are kept under "3goats". The pages themselves are named "task" and "solutions". So there is a page "3goats/Task" and a page "3goats/Solution". |
| Line 22: | Line 34: |
| For example, if you want to add a "!MySpecialPage" to the !DotNotSamples page, specify "!DotNotSamples page/MySpecialPage" as page name. Consult the help pages for more information. | == Dyalog Version 11 == |
| Line 24: | Line 36: |
| === Categories === Adding a string "!CategorySomething" offer a link to a so-called category page. When such a page is created, a MoinMoin macro can be inserted to produce dynamically a list of pages which also contains such a link. That is very usefule because new pages are automatically added to the list as soon as the become available. === Conclusion === For top-level links, using sub pages is recommended. For all other pages, make sure that they belong to at least one category. However, you may also use the sub page mechanism. == .NET pathes == |
=== .NET pathes === |
Providing useful information to APL programmers can be done in a number of ways. In a Wiki, there is no way to force people to follow particular conventions. You might think about this as an invitation to create chaos. A very different view would be that this way good things will defat the less good ones sooner or later.
However, here are some hints and suggestions you might find useful.
Linking
Adding a new page
To add a new page first follow these steps:
- Look for an appropriate page you want to put a link on.
Change that page by adding the link. Using CamelCase is the easiest way to do so, but you can also use more sophisticated links; Refere to HelpOnLinking for details.
- Click at the link you have just created. This gives you the opportunity to created a new page from scratch.
How to Provide Code
At the time being (2006-12-24) examples are provided as code block with lots of comments. This means that one can create the code in an APL workspace which can be saved for later use, like maintaining or enhancing.
On the other side you might find all the comment lines annoying the code is coming with.
Author
If you have created a particular page, please put a "Author: FirstnameLastname" at the end of the article if you are willing to keep an eye on the page. Write it like KaiJaeger because this let the Wiki link automatically to your "homepage". This is another good reason to create such a homepage.
Categories
Adding a string "CategorySomething" offer a link to a so-called category page. When such a page is created, a MoinMoin macro can be inserted to produce dynamically a list of pages which also contains such a link. This is very useful because new pages are automatically added to the list as soon as they become available.
You might connect a particular page to several categories if this is appropriate. This makes it easier for others to find the page.
Sub Pages
Use the "!Mainpage/Subpage" mechanism when appropriate. An example is the three-goats-problem: On one page, the task is defined, on a second the solution explained. Both pages are kept under "3goats". The pages themselves are named "task" and "solutions". So there is a page "3goats/Task" and a page "3goats/Solution".
Dyalog Version 11
.NET pathes
Address .NET methods/classes/enumerations/interfaces always fully. This makes it not only easier to understand the code, it makes also much easier to find related articles. For example, if you use the ⎕USING mechanism, you can call the method "ShowHelp" from System.Windows.Forms.Help by adressing it as "ShowHelp". Surely there are plenty of other methods with exactly the same name! So it is more appropriate to search for System.Windows.Forms.Help.ShowHelp if your are looking for an example how to use this .NET method.