Building Web Applications in Copyleft Mexico

Part 5 — Wiktig


Part 1: https://medium.com/@leoutskot/building-web-applications-in-copyleft-mexico-e21ec70d44e

Part 2: https://medium.com/@leoutskot/building-web-applications-in-copyleft-mexico-315c5ea39bba

Part 3: https://medium.com/@leoutskot/building-web-applications-in-copyleft-mexico-a3baac78d85

Part 4: https://medium.com/@leoutskot/building-web-applications-in-mexico-7d38d7e34241

Permanent documentation for everything related to Copyleft is stored in out Wiki-system called Wiktig. Permanent documentation refers to documentation which is not related to a specific task, but relates to a person, company or project we’re involved with. If you don’t know what a Wiki is then read about it here: https://en.wikipedia.org/wiki/Wiki

Remember: Wiki is a type of documentation system. Wiktig is our system.

Navigation —How to find the articles

Wiktig is quite big with over 20,000 articles in it. It covers anything from Daniel’s sister’s birthday to client contacts.

There are a few ways to navigate the Wiki:

Via the homepage
After loginm you are presented with an “Area home”. This is the homepage for the default Area configured in your user. Normally this will be the Copyleft Mexico homepage. From the homepage, you can go to one of the areas like “Administración” or scroll down a little more and you will find the link to “Projects.” From Projects, you can get to most of the relevant articles.


Via the GO TO form
There are two boxes on the right side of the screen, the first one is the GO TO form. If you write something there and hit the button or press return then you will jump straight to the article. This works if you know what the article is called. Try it for “Leo” for example.


Via the SEARCH form
The other form below GO TO is a normal search form. Enter a word, hit the button or press return and the system will try to find what you are looking for.

Editing

Editing is done using the orange tab at the top called EDIT. When you click the EDIT tab you go to a different view of the article you are on and see the code behind the article content. The code is very simple but text-based, so you don’t have a fancy editor with buttons like Word, but instead write special characters around content to indicate how you want it to look.

You can make headings, subheadings, lists of different types and links (see below). You can also format text a little by making them bold or italic.

Each employee has his or her own article. This is a good place to play around with the edit function.

Rollback — fixing mistakes
The wiki also has a feature to roll back changes to previous versions so it’s not a crisis of you make a mistake. This is done in the Changes box on the right side.

Linking and creating new articles

Most most central part of any Wiki is the links. This is how the Wiki gets structured and this is how we can navigate further into articles and details.

To create a link from any article to any other article you just have to know the name of the article you are linking to and write [[Article name]] anywhere in the content and this will become a link to that article.

To create a new article you just make a new link to an article that doesn’t exist and this becomes a link to the new article. The only thing you have to take care of is to know where the new article will be linked to. A good starting point will often be [[Projects]] or [[People]].

Bonanza links can be made by simply writing issue followed directly by the issuenumber, without a space: issue162172.

Structure for Project articles

All Project articles should have a link to the Client article. Don’t put client details inside the project article because one client often has several projects.

This is the default structure for any project article:

  • Overview — A brief overview of what the project is about, who the client is and a mention of when the project is being done and any important deadlines (make sure to include the year). Also include links to development or production versions of the system.
  • Involved — A list of people that are involved and their role. Include both people in Copyleft and the people involved from the client’s side. Include name, position, role, email and phone numbers for external people. For internal people make sure to create a link to their article like
    [[Leo]] — Project manager.
  • Resources — A general section with links to related resources. This should always include a link to the sales issue the main project in Bonanza. Also, link to external resources like design manuals, API documentation, etc.
  • Hosting — The hosting section should include any domain/hostname used, servers used, git repos and links to bonanza issues used to set up the hosting.