--- doc/docbase/writing_docs/01_writing_docs.html 2015/04/28 22:21:20 2740 +++ doc/docbase/writing_docs/01_writing_docs.html 2015/04/29 00:14:30 2741 @@ -124,7 +124,7 @@ Creating a new article for this site is as simple as creating a new text file and adding following text:
-
+
My First Article
This is the first paragraph.
@@ -297,12 +297,12 @@
somewhere in your article a headline called "Conclusion of Topic", then
this particular paragraph of your article may be directly linked to from
other articles or other sites with an URL like
- http://doc.linuxsampler.org/path/to/your/article/#conclusion_of_topic
.
+ http://doc.linuxsampler.org/path/to/your/article/#conclusion_of_topic
.
If you want to override this behavior, because you rather want to use your
own ID for a paragraph of your article, then simply set the desired ID with
your headline:
-
+
Conclusion of topic
@@ -571,7 +571,7 @@
do that: simply put the code block into the paragraph text block of your
HTML file:
-
+
A variable is assigned with NKSP like this <code>$foo := 5</code>, in this
case you are assigning <code>5</code> to the integer variable <code>$foo</code>.
@@ -602,13 +602,13 @@
Metaphors
- You might have noticed, we have used a special kind of ??place-holder??
for
+ You might have noticed, we have used a special kind of ??place-holder??
for
human-readable portions in source code before, which shall outline to the reader
that it is not actually "real" source code, but just reflecting its semantic meaning.
Simply put the respective pseudo-code into a pair of two question marks,
like so:
-
+
<code>
on init
declare const $i = \?\?some-value\?\?
@@ -641,7 +641,7 @@
If you want to add links in your article to another article or to some
other website, then you just use an ordinary HTML link tag pair:
-
+
This paragraph contains <a href="../nksp.html">a link to another article</a>
and to <a href="http://www.linuxsampler.org">another website</a>.
@@ -671,7 +671,7 @@
An article file on our site usually has the following
file name form:
-
+
??number-prefix??_??unique-name??.html
@@ -694,7 +694,7 @@
Technical terms and abbreviations are often used in articles to reduce
the amount of text for transmitting some kind of information about a
certain topic to the reader. You might want to emphasize technical terms and abbreviations
- in your article, by wrapping the term into a pair of
HTML
+ in your article, by wrapping the term into a pair of
HTML
tags. On our site this will not only show the term in a special unified
font style (currently italic), but it allows you also to define the
meaning of the term once. Which goes like this:
@@ -704,7 +704,7 @@
You may define a new term like this:
-
+
He left the bar and jumped right into his
<i title="A very large vehicle.">Mega Liner</i>