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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2733 by schoenebeck,
Sun Apr 26 23:49:16 2015 UTC
+revision 2741 by schoenebeck,
Wed Apr 29 00:14:30 2015 UTC
 Line 3
      <meta name="author" content="Christian Schoenebeck">
      <title>Writing Docs</title>
      <meta name="description" content="Writing new articles for this site.">
+     <link rel="stylesheet" href="http://doc.linuxsampler.org/css/preview.css">
+     <script type="text/javascript" src="http://doc.linuxsampler.org/js/preview.js"></script>
    </head>
    <body>
      <p>
-Line 122
+Line 124
        Creating a new article for this site is as simple as creating a new text
        file and adding following text:
      </p>
-     <code l="html">
+     <code lang="html">
  <h1>My First Article</h1>
  <p>
    This is the first paragraph.
-Line 289
+Line 291
        which will be shown at the left side next to your article on our site.
      </p>
      <p>
-       Once your article is uploaded to our site, IDs for the individual
+       Once your article is
+       <a href="02_uploading_docs.html">uploaded to our site</a>, IDs for the individual
        headlines will automatically be generated for you. If for example you had
        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
-       <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>.
        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:
      </p>
-     <code>
+     <code lang="html">
  <h3 id="my_conclusion">Conclusion of topic</h3>
      </code>
-Line 441
+Line 444
      <h3>Unique Pictures</h3>
      <p>
-       Once your article and its picture(s) are uploaded to our server, our
+       Once your article and its picture(s) are
+       <a href="02_uploading_docs.html">uploaded to our server</a>, our
        system will automatically check that all images on our entire site have
        unique and unambiguous file names, no matter at which directory they
        are stored to exactly. The "file name" that is checked in this case, is
-Line 567 
 end on
+Line 571 
 end on
        do that: simply put the code block into the paragraph text block of your
        HTML file:
      </p>
-     <code>
+     <code lang="html">
  <p>
    A variable is assigned with NKSP like this &lt;code&gt;$foo := 5&lt;/code&gt;, in this
    case you are assigning &lt;code&gt;5&lt;/code&gt; to the integer variable &lt;code&gt;$foo&lt;/code&gt;.
-Line 588 
 end on
+Line 592 
 end on
      <note>
        Syntax highlighting of source code is automatically generated by our site's software
-       once the document is uploaded to our server. So when you are just
+       once the document is
+       <a href="02_uploading_docs.html">uploaded to our server</a>.
+       So when you are just
        previewing your article with source code snippets on your local machine,
        then those source code snippets will yet be displayed monochrome,
        without any syntax highlighting.
-Line 596 
 end on
+Line 602 
 end on
      <h3>Metaphors</h3>
      <p>
-       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
        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:
      </p>
-     <code>
+     <code lang="html">
  &lt;code&gt;
  on init
    declare const $i = \?\?some-value\?\?
-Line 635 
 end on
+Line 641 
 end on
        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:
      </p>
-     <code>
+     <code lang="html">
  <p>
    This paragraph contains &lt;a href="../nksp.html"&gt;a link to another article&lt;/a&gt;
    and to &lt;a href="http://www.linuxsampler.org"&gt;another website&lt;/a&gt;.
-Line 665 
 end on
+Line 671 
 end on
        An article file on our site usually has the following
        file name form:
      </p>
-     <code>
+     <code lang="none">
  ??number-prefix??_??unique-name??.html
      </code>
      <p>
-Line 688 
 end on
+Line 694 
 end on
        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 <code><i></code> HTML
+       in your article, by wrapping the term into a pair of <code lang="html"><i></code> 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 <b>once</b>. Which goes like this:
-Line 698 
 end on
+Line 704 
 end on
       <p>
        You may define a new term like this:
      </p>
-     <code>
+     <code lang="html">
  <p>
    He left the bar and jumped right into his
    &lt;i title="A very large vehicle."&gt;Mega Liner&lt;/i&gt;
-Line 722 
 end on
+Line 728 
 end on
        Obviously you don't want to define
        the same term over and over again, just to provide the user the meaning of
        it at any occurence of the site. That's why our software does that
-       automatically for you once your article is uploaded to our server. Now
+       automatically for you once your article is
-       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>.
+       Now when you use the term at another place, i.e. in another article, then
        it will automatically have the same meaning attached to it:
      </p>
      <code>
-Line 763 
 end on
+Line 770 
 end on
        Tables are written like ordinary HTML tables. That is:
      </p>
      <code>
- <table>
+ &lt;table&gt;
-   <tr>
+   &lt;tr&gt;
-     <th>Name</th> <th>Description</th>
+     &lt;th&gt;Name&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt;
-   </tr>
+   &lt;/tr&gt;
-   <tr>
+   &lt;tr&gt;
-     <td>Foo</td> <td>Some text.</td>
+     &lt;td&gt;Foo&lt;/td&gt; &lt;td&gt;Some text.&lt;/td&gt;
-   </tr>
+   &lt;/tr&gt;
-   <tr>
+   &lt;tr&gt;
-     <td>Bar</td> <td>And more text.</td>
+     &lt;td&gt;Bar&lt;/td&gt; &lt;td&gt;And more text.&lt;/td&gt;
-   </tr>
+   &lt;/tr&gt;
-   <tr>
+   &lt;tr&gt;
-     <td>Thing</td> <td>And that's it.</td>
+     &lt;td&gt;Thing&lt;/td&gt; &lt;td&gt;And that's it.&lt;/td&gt;
-   </tr>
+   &lt;/tr&gt;
- </table>
+ &lt;/table&gt;
      </code>
      <example>
        <table>
-Line 871 
 end on
+Line 878 
 end on
        manage articles of our documentation site on your own.
      </p>
      <p>
+       You already got a Subversion account? Then continue reading
+       <a href="02_uploading_docs.html">how to upload articles</a> for this site.
+     </p>
+     <p>
        Thanks for your support!
      </p>

 Legend:



Removed from v.2733
 


changed lines


 
Added in v.2741
 Legend:



Removed from v.2733
 


changed lines


 
Added in v.2741
-Removed from v.2733
+Added in v.2741

	ViewVC Help
Powered by ViewVC