/[svn]/doc/docbase/writing_docs/01_writing_docs.html
ViewVC logotype

Diff of /doc/docbase/writing_docs/01_writing_docs.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2739 by schoenebeck, Tue Apr 28 19:33:56 2015 UTC revision 2741 by schoenebeck, Wed Apr 29 00:14:30 2015 UTC
# Line 124  Line 124 
124        Creating a new article for this site is as simple as creating a new text        Creating a new article for this site is as simple as creating a new text
125        file and adding following text:        file and adding following text:
126      </p>      </p>
127      <code l="html">      <code lang="html">
128  <h1>My First Article</h1>  <h1>My First Article</h1>
129  <p>  <p>
130    This is the first paragraph.    This is the first paragraph.
# Line 297  Line 297 
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
299        other articles or other sites with an URL like        other articles or other sites with an URL like
300        <code>http://doc.linuxsampler.org/path/to/your/article/#conclusion_of_topic</code>.        <code lang="none">http://doc.linuxsampler.org/path/to/your/article/#conclusion_of_topic</code>.
301        If you want to override this behavior, because you rather want to use your        If you want to override this behavior, because you rather want to use your
302        own ID for a paragraph of your article, then simply set the desired ID with        own ID for a paragraph of your article, then simply set the desired ID with
303        your headline:        your headline:
304      </p>      </p>
305      <code>      <code lang="html">
306  <h3 id="my_conclusion">Conclusion of topic</h3>  <h3 id="my_conclusion">Conclusion of topic</h3>
307      </code>      </code>
308            
# Line 571  end on Line 571  end on
571        do that: simply put the code block into the paragraph text block of your        do that: simply put the code block into the paragraph text block of your
572        HTML file:        HTML file:
573      </p>      </p>
574      <code>      <code lang="html">
575  <p>  <p>
576    A variable is assigned with NKSP like this &lt;code&gt;$foo := 5&lt;/code&gt;, in this    A variable is assigned with NKSP like this &lt;code&gt;$foo := 5&lt;/code&gt;, in this
577    case you are assigning &lt;code&gt;5&lt;/code&gt; to the integer variable &lt;code&gt;$foo&lt;/code&gt;.    case you are assigning &lt;code&gt;5&lt;/code&gt; to the integer variable &lt;code&gt;$foo&lt;/code&gt;.
# Line 602  end on Line 602  end on
602            
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 lang="html">??place-holder??</code> for
606        human-readable portions in source code before, which shall outline to the reader        human-readable portions in source code before, which shall outline to the reader
607        that it is not actually "real" source code, but just reflecting its semantic meaning.        that it is not actually "real" source code, but just reflecting its semantic meaning.
608        Simply put the respective pseudo-code into a pair of two question marks,        Simply put the respective pseudo-code into a pair of two question marks,
609        like so:        like so:
610      </p>      </p>
611      <code>      <code lang="html">
612  &lt;code&gt;  &lt;code&gt;
613  on init  on init
614    declare const $i = \?\?some-value\?\?    declare const $i = \?\?some-value\?\?
# Line 641  end on Line 641  end on
641        If you want to add links in your article to another article or to some        If you want to add links in your article to another article or to some
642        other website, then you just use an ordinary HTML link tag pair:        other website, then you just use an ordinary HTML link tag pair:
643      </p>      </p>
644      <code>      <code lang="html">
645  <p>  <p>
646    This paragraph contains &lt;a href="../nksp.html"&gt;a link to another article&lt;/a&gt;    This paragraph contains &lt;a href="../nksp.html"&gt;a link to another article&lt;/a&gt;
647    and to &lt;a href="http://www.linuxsampler.org"&gt;another website&lt;/a&gt;.    and to &lt;a href="http://www.linuxsampler.org"&gt;another website&lt;/a&gt;.
# Line 671  end on Line 671  end on
671        An article file on our site usually has the following        An article file on our site usually has the following
672        file name form:        file name form:
673      </p>      </p>
674      <code>      <code lang="none">
675  ??number-prefix??_??unique-name??.html  ??number-prefix??_??unique-name??.html
676      </code>      </code>
677      <p>      <p>
# Line 694  end on Line 694  end on
694        Technical terms and abbreviations are often used in articles to reduce        Technical terms and abbreviations are often used in articles to reduce
695        the amount of text for transmitting some kind of information about a        the amount of text for transmitting some kind of information about a
696        certain topic to the reader. You might want to emphasize technical terms and abbreviations        certain topic to the reader. You might want to emphasize technical terms and abbreviations
697        in your article, by wrapping the term into a pair of <code><i></code> HTML        in your article, by wrapping the term into a pair of <code lang="html"><i></code> HTML
698        tags. On our site this will not only show the term in a special unified        tags. On our site this will not only show the term in a special unified
699        font style (currently italic), but it allows you also to define the        font style (currently italic), but it allows you also to define the
700        meaning of the term <b>once</b>. Which goes like this:        meaning of the term <b>once</b>. Which goes like this:
# Line 704  end on Line 704  end on
704       <p>       <p>
705        You may define a new term like this:        You may define a new term like this:
706      </p>      </p>
707      <code>      <code lang="html">
708  <p>  <p>
709    He left the bar and jumped right into his    He left the bar and jumped right into his
710    &lt;i title="A very large vehicle."&gt;Mega Liner&lt;/i&gt;    &lt;i title="A very large vehicle."&gt;Mega Liner&lt;/i&gt;
Legend:
Removed from v.2739  
changed lines
  Added in v.2741
  ViewVC Help
Powered by ViewVC