3 |
<meta name="author" content="Christian Schoenebeck"> |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>Writing Docs</title> |
<title>Writing Docs</title> |
5 |
<meta name="description" content="Writing new articles for this site."> |
<meta name="description" content="Writing new articles for this site."> |
6 |
|
<link rel="stylesheet" href="http://doc.linuxsampler.org/css/preview.css"> |
7 |
|
<script type="text/javascript" src="http://doc.linuxsampler.org/js/preview.js"></script> |
8 |
</head> |
</head> |
9 |
<body> |
<body> |
10 |
<p> |
<p> |
291 |
which will be shown at the left side next to your article on our site. |
which will be shown at the left side next to your article on our site. |
292 |
</p> |
</p> |
293 |
<p> |
<p> |
294 |
Once your article is uploaded to our site, IDs for the individual |
Once your article is |
295 |
|
<a href="02_uploading_docs.html">uploaded to our site</a>, IDs for the individual |
296 |
headlines will automatically be generated for you. If for example you had |
headlines will automatically be generated for you. If for example you had |
297 |
somewhere in your article a headline called "Conclusion of Topic", then |
somewhere in your article a headline called "Conclusion of Topic", then |
298 |
this particular paragraph of your article may be directly linked to from |
this particular paragraph of your article may be directly linked to from |
444 |
|
|
445 |
<h3>Unique Pictures</h3> |
<h3>Unique Pictures</h3> |
446 |
<p> |
<p> |
447 |
Once your article and its picture(s) are uploaded to our server, our |
Once your article and its picture(s) are |
448 |
|
<a href="02_uploading_docs.html">uploaded to our server</a>, our |
449 |
system will automatically check that all images on our entire site have |
system will automatically check that all images on our entire site have |
450 |
unique and unambiguous file names, no matter at which directory they |
unique and unambiguous file names, no matter at which directory they |
451 |
are stored to exactly. The "file name" that is checked in this case, is |
are stored to exactly. The "file name" that is checked in this case, is |
506 |
as described next. |
as described next. |
507 |
</p> |
</p> |
508 |
|
|
509 |
|
<note> |
510 |
|
Automatic syntax highlighting is currently available for the |
511 |
|
<ul> |
512 |
|
<li><a href="nksp.html">NKSP real-time instrument script language</a></li> |
513 |
|
<li>HTML markup language</li> |
514 |
|
</ul> |
515 |
|
If you need another source code language, just tell |
516 |
|
<a href="http://www.linuxsampler.org/developers.html#Schoenebeck">Christian</a> |
517 |
|
and he will add the required module for any kind of language |
518 |
|
(even the most exotic one) on our server in short time. |
519 |
|
</note> |
520 |
|
|
521 |
<h3>Stand-Alone Code</h3> |
<h3>Stand-Alone Code</h3> |
522 |
<p> |
<p> |
523 |
If you put your code block outside of paragraphs, that is between |
If you put your code block outside of paragraphs, that is between |
592 |
|
|
593 |
<note> |
<note> |
594 |
Syntax highlighting of source code is automatically generated by our site's software |
Syntax highlighting of source code is automatically generated by our site's software |
595 |
once the document is uploaded to our server. So when you are just |
once the document is |
596 |
|
<a href="02_uploading_docs.html">uploaded to our server</a>. |
597 |
|
So when you are just |
598 |
previewing your article with source code snippets on your local machine, |
previewing your article with source code snippets on your local machine, |
599 |
then those source code snippets will yet be displayed monochrome, |
then those source code snippets will yet be displayed monochrome, |
600 |
without any syntax highlighting. |
without any syntax highlighting. |
601 |
</note> |
</note> |
602 |
|
|
|
<note> |
|
|
Automatic syntax highlighting is currently available for the |
|
|
<ul> |
|
|
<li>NKSP real-time instrument script language |
|
|
<li>HTML markup language</li> |
|
|
</ul> |
|
|
If you need another source code language, just tell |
|
|
<a href="http://www.linuxsampler.org/developers.html#Schoenebeck">Christian</a> |
|
|
and he will add the required module for any kind of language |
|
|
(even the most exotic one) on our server in short time. |
|
|
</note> |
|
|
|
|
603 |
<h3>Metaphors</h3> |
<h3>Metaphors</h3> |
604 |
<p> |
<p> |
605 |
You might have noticed, we have used a special kind of <code>??place-holder??</code> for |
You might have noticed, we have used a special kind of <code>??place-holder??</code> for |
728 |
Obviously you don't want to define |
Obviously you don't want to define |
729 |
the same term over and over again, just to provide the user the meaning of |
the same term over and over again, just to provide the user the meaning of |
730 |
it at any occurence of the site. That's why our software does that |
it at any occurence of the site. That's why our software does that |
731 |
automatically for you once your article is uploaded to our server. Now |
automatically for you once your article is |
732 |
when you use the term at another place, i.e. in another article, then |
<a href="02_uploading_docs.html">uploaded to our server</a>. |
733 |
|
Now when you use the term at another place, i.e. in another article, then |
734 |
it will automatically have the same meaning attached to it: |
it will automatically have the same meaning attached to it: |
735 |
</p> |
</p> |
736 |
<code> |
<code> |
770 |
Tables are written like ordinary HTML tables. That is: |
Tables are written like ordinary HTML tables. That is: |
771 |
</p> |
</p> |
772 |
<code> |
<code> |
773 |
<table> |
<table> |
774 |
<tr> |
<tr> |
775 |
<th>Name</th> <th>Description</th> |
<th>Name</th> <th>Description</th> |
776 |
</tr> |
</tr> |
777 |
<tr> |
<tr> |
778 |
<td>Foo</td> <td>Some text.</td> |
<td>Foo</td> <td>Some text.</td> |
779 |
</tr> |
</tr> |
780 |
<tr> |
<tr> |
781 |
<td>Bar</td> <td>And more text.</td> |
<td>Bar</td> <td>And more text.</td> |
782 |
</tr> |
</tr> |
783 |
<tr> |
<tr> |
784 |
<td>Thing</td> <td>And that's it.</td> |
<td>Thing</td> <td>And that's it.</td> |
785 |
</tr> |
</tr> |
786 |
</table> |
</table> |
787 |
</code> |
</code> |
788 |
<example> |
<example> |
789 |
<table> |
<table> |
878 |
manage articles of our documentation site on your own. |
manage articles of our documentation site on your own. |
879 |
</p> |
</p> |
880 |
<p> |
<p> |
881 |
|
You already got a Subversion account? Then continue reading |
882 |
|
<a href="02_uploading_docs.html">how to upload articles</a> for this site. |
883 |
|
</p> |
884 |
|
<p> |
885 |
Thanks for your support! |
Thanks for your support! |
886 |
</p> |
</p> |
887 |
|
|