/[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 2741 by schoenebeck, Wed Apr 29 00:14:30 2015 UTC revision 2748 by schoenebeck, Wed Apr 29 10:55:48 2015 UTC
# Line 491  Line 491 
491        <code>&lt;code&gt;</code> tags like this:        <code>&lt;code&gt;</code> tags like this:
492      </p>      </p>
493      <code>      <code>
494  &lt;code&gt;  &lt;code lang="??language??"&gt;
495    
496    ??source-code??    ??source-code??
497        
498  &lt;/code&gt;  &lt;/code&gt;
499      </code>      </code>
500      <p>      <p>
501        Syntax highlighting is automatically generated for you, according to the        Syntax highlighting is automatically generated for you. That way you don't
       programming language or markup language used by 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. Like with images, you can        concentrate on the content of your article instead.
504          You should provide the intended programming language of your source code sample
505          with <code>??language??</code>.
506          Obviously it is exhausting to supply such a <code lang="none">lang</code>
507          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
510          software will automatically use the language defined by you with one of
511          the previous code blocks. You may also disable automatic syntax highlighting
512          with <code lang="html">&lt;code lang="none"&gt;</code>, which will cause
513          that code block to appear simply in monochrome color.
514        </p>
515        <p>
516          Like with images, you can
517        decide in which context the source code shall appear in your article,        decide in which context the source code shall appear in your article,
518        as described next.        as described next.
519      </p>      </p>
# Line 525  Line 537 
537        on its own between the paragraph blocks. Here is an example for the        on its own between the paragraph blocks. Here is an example for the
538        <a href="nksp.html">NKSP script language</a>.        <a href="nksp.html">NKSP script language</a>.
539      </p>      </p>
540      <code>      <code lang="html">
541  <p>  <p>
542    Paragraph just before the source code block.    Paragraph just before the source code block.
543  </p>  </p>
544  &lt;code&gt;  &lt;code lang="nksp"&gt;
545  on init  on init
546    @foo := "A message"    @foo := "A message"
547    message(@foo)    message(@foo)
# Line 856  end on Line 868  end on
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          &lt;dir&gt;/
881            &lt;dir&gt;home
882              &lt;dir&gt;bob
883                &lt;file&gt;README.txt&lt;/file&gt;
884                &lt;file&gt;foo.sh&lt;/file&gt;
885              &lt;/dir&gt;
886            &lt;/dir&gt;
887            &lt;dir&gt;tmp
888              &lt;file&gt;bla.tmp&lt;/file&gt;
889            &lt;/dir&gt;
890          &lt;/dir&gt;
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
# Line 872  end on Line 923  end on
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>
Legend:
Removed from v.2741  
changed lines
  Added in v.2748
  ViewVC Help
Powered by ViewVC