501 |
Syntax highlighting is automatically generated for you. That way you don't |
Syntax highlighting is automatically generated for you. That way you don't |
502 |
have to waste time on how to display source code nicely, and rather |
have to waste time on how to display source code nicely, and rather |
503 |
concentrate on the content of your article instead. |
concentrate on the content of your article instead. |
504 |
You should provide the intended programming with <code>??language??</code>. |
You should provide the intended programming language of your source code sample |
505 |
Obviously it is exhausting to provide such a <code lang="none">lang</code> |
with <code>??language??</code>. |
506 |
attribute with every single code sample, especially if you are just refering |
Obviously it is exhausting to supply such a <code lang="none">lang</code> |
507 |
a single code token within your paragraphs. So you don't have to do that. |
attribute with every single code sample, especially if you are just referring |
508 |
|
to a single code token within your paragraphs. So you don't have to do that. |
509 |
If you omit the <code lang="none">lang</code> attribute, then our site's |
If you omit the <code lang="none">lang</code> attribute, then our site's |
510 |
software will automatically use the language defined by your with one of |
software will automatically use the language defined by you with one of |
511 |
the previous code blocks. |
the previous code blocks. You may also disable automatic syntax highlighting |
512 |
|
with <code lang="html"><code lang="none"></code>, which will cause |
513 |
|
that code block to appear simply in monochrome color. |
514 |
</p> |
</p> |
515 |
<p> |
<p> |
516 |
Like with images, you can |
Like with images, you can |
868 |
The only thing that changed compared to the regular note, is the "class" |
The only thing that changed compared to the regular note, is the "class" |
869 |
attribute of the note tag. |
attribute of the note tag. |
870 |
</p> |
</p> |
871 |
|
|
872 |
|
<h2>Directory Listings</h2> |
873 |
|
<p> |
874 |
|
Software components often have a certain kind of directory structure. |
875 |
|
For readers of your articles is it way easier to perceive directory |
876 |
|
structures if they are displayed in a visual appropriate way. There are |
877 |
|
two specials tags you can use for this purpose: |
878 |
|
</p> |
879 |
|
<code lang="html"> |
880 |
|
<dir>/ |
881 |
|
<dir>home |
882 |
|
<dir>bob |
883 |
|
<file>README.txt</file> |
884 |
|
<file>foo.sh</file> |
885 |
|
</dir> |
886 |
|
</dir> |
887 |
|
<dir>tmp |
888 |
|
<file>bla.tmp</file> |
889 |
|
</dir> |
890 |
|
</dir> |
891 |
|
</code> |
892 |
|
<example> |
893 |
|
<dir>/ |
894 |
|
<dir>home |
895 |
|
<dir>bob |
896 |
|
<file>README.txt</file> |
897 |
|
<file>foo.sh</file> |
898 |
|
</dir> |
899 |
|
</dir> |
900 |
|
<dir>tmp |
901 |
|
<file>bla.tmp</file> |
902 |
|
</dir> |
903 |
|
</dir> |
904 |
|
</example> |
905 |
|
<p> |
906 |
|
Currently for each file the same icon will be displayed. This might change |
907 |
|
in future, i.e. a an automatic different icon could be picked by the |
908 |
|
site's software according to the respective file name extension. |
909 |
|
</p> |
910 |
|
|
911 |
<h2>Extensions</h2> |
<h2>Extensions</h2> |
912 |
<p> |
<p> |
913 |
This is almost the end of this article. You are still seeking for features |
This is almost the end of this article. You are still seeking for features |
923 |
You are at the end of our tour introducing our documentation system. |
You are at the end of our tour introducing our documentation system. |
924 |
You may now start writing your first article. Once you are done with it, |
You may now start writing your first article. Once you are done with it, |
925 |
simply |
simply |
926 |
<a href="http://www.linuxsampler.org/developers.html"> |
<a href="http://www.linuxsampler.org/developers.html">send your article to some of us</a>, |
927 |
send your article to some of us |
or request an account to our Subversion repository, so you can |
|
</a>, or request an account to our Subversion repository, so you can |
|
928 |
manage articles of our documentation site on your own. |
manage articles of our documentation site on your own. |
929 |
</p> |
</p> |
930 |
<p> |
<p> |