Starting a new article

Make sure that the topic is not covered elsewhere: Search for the relevant keywords of the topic you would like describe on a new page.
Log in before you begin writing. We prefer that the authors are identifiable by their user name (which should reflect the real name).

Writing page titles

Writing a good page title is essential to make the information easily accessible.

Search fields and aggregated lists on pages like TechNotes are based on keywords appearing in page titles, so titles should contain all the important keywords so as that users can find the relevant information easily.
In addition to contain relevant keywords, titles should be as short as possible, especially article titles. Tech Note and Bug Description titles should start with the "TechNotes/" and "Bugs/" keywords respectively, and these are to be followed by a really short summary of the page.
Article titles are to be referenced from various other pages too, therefore their titles should not be more than a keyword or a short expression consisting of 2-3 words.
Slash ( / ) has a special function, so do not use in titles unless you would like to create SubPages

Using templates

There are three different page types in this wiki: TechNoteTemplate, BugTemplate, ArticleTemplate. Use them according the description below:

Tech Note is a step-by-step description of a method, trick, workaround or other procedure.
Bug description
Article is the default page type in this wiki

Every page has a header box that contains general information about the content. Various page lists are aggregated based on this set of data, so set these values appropriately. Delete the unnecessary values (by default all possible values are listed).

Keep the structure that the template offers. E.g. if you write about a bug, clearly describe the phenomenon, the cause, and the workaround.

Formatting

Only a restricted set of formatting options is available here, those which are necessary to write a semantically correct document: headers, paragraphs, lists, tables, basic text decoration and identation, plus links, images (text color and font-face cannot be determined for instance). These options are present on the icon bar of the GUI editor or examples are listed below the text area of if you opted for Text editor mode. Read more about formatting options on SyntaxReference.

In theory it is posible to copy + paste documents from Word processing applications (such as Microsoft Word or OpenOffice.org,) preserving text formatting using the GUI Editor, but this will fail in many cases, because the WYSIWYG editor of this Wiki cannot always handle invalid markup code generated by these applications.

Creating links

Outbound links: Please put link on every important keyword at the first occurence

If a keyword is Archicad-specific, then check if the article exists, and link to it.
If a keyword is not strictly Archicad related, or most likely there won't be any more info added to the topic in question then please use the InterWiki links

Inbound links: Ensure that the newly created page is referenced from other relevant pages: Search for the page title (and for similar expressions too) to see where are the key expressions mentioned on other pages, and create a link to the new page from there.

Using special macros

There are a few add-ons, so called macros installed on the server for special features:

Resizing images

Instead of using attachment:pic.png to display an image, use [[Image(pic.png,height=100, alt=your description)]] to display resized with an optional alt text.

Inserting YouTube videos

Simply insert the ID of the uploaded video using the following format : [[YouTube(V8tSRJ8e3b0)]]