--- doc/docbase/writing_docs/01_writing_docs.html 2015/04/29 01:20:07 2743 +++ doc/docbase/writing_docs/01_writing_docs.html 2015/04/29 10:55:48 2748 @@ -498,16 +498,19 @@ </code>

- Syntax highlighting is automatically generated for you That way you don't + Syntax highlighting is automatically generated for you. That way you don't have to waste time on how to display source code nicely, and rather - concentrate on the content of your article. - You should provide the intended programming with ??language??. - Obviously it is exhausting to provide such a lang - attribute with every single code sample, especially if you are just refering - a single code token within your paragraphs. So you don't have to do that. + concentrate on the content of your article instead. + You should provide the intended programming language of your source code sample + with ??language??. + Obviously it is exhausting to supply such a lang + attribute with every single code sample, especially if you are just referring + to a single code token within your paragraphs. So you don't have to do that. If you omit the lang attribute, then our site's - software will automatically use the language defined by your with one of - the previous code blocks. + software will automatically use the language defined by you with one of + the previous code blocks. You may also disable automatic syntax highlighting + with <code lang="none">, which will cause + that code block to appear simply in monochrome color.

Like with images, you can @@ -865,7 +868,46 @@ The only thing that changed compared to the regular note, is the "class" attribute of the note tag.

- + +

Directory Listings

+

+ Software components often have a certain kind of directory structure. + For readers of your articles is it way easier to perceive directory + structures if they are displayed in a visual appropriate way. There are + two specials tags you can use for this purpose: +

+ + <dir>/ + <dir>home + <dir>bob + <file>README.txt</file> + <file>foo.sh</file> + </dir> + </dir> + <dir>tmp + <file>bla.tmp</file> + </dir> + </dir> + + + / + home + bob + README.txt + foo.sh + + + tmp + bla.tmp + + + +

+ Currently for each file the same icon will be displayed. This might change + in future, i.e. a an automatic different icon could be picked by the + site's software according to the respective file name extension. +

+

Extensions

This is almost the end of this article. You are still seeking for features @@ -881,9 +923,8 @@ You are at the end of our tour introducing our documentation system. You may now start writing your first article. Once you are done with it, simply - - send your article to some of us - , or request an account to our Subversion repository, so you can + send your article to some of us, + or request an account to our Subversion repository, so you can manage articles of our documentation site on your own.