/[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 2744 by schoenebeck, Wed Apr 29 01:22:46 2015 UTC revision 3083 by schoenebeck, Mon Jan 9 19:23:58 2017 UTC
# Line 365  Line 365 
365    This is the first paragraph. Just before the picture.    This is the first paragraph. Just before the picture.
366  </p>  </p>
367    
368  <img src="some_picture.png" caption="??footnote??" title="??tooltip-text??">  &lt;img src="some_picture.png" caption="??footnote??" title="??tooltip-text??"&gt;
369    
370  <p>  <p>
371    This is the next paragraph, just after the picture.    This is the next paragraph, just after the picture.
# Line 387  Line 387 
387        </p>        </p>
388      </example>      </example>
389      <p>      <p>
390        You also don't have to care about the size of the image. If the image        You also don't have to worry about the size of the image. If the image
391        resolution is largen than the width of the article would currently require        resolution is larger than the width of the article would currently require
392        on the user's screen, then the image will automatically be downscaled to        on the user's screen, then the image will automatically be downscaled to
393        fit the width of the article. It is recommended though to keep the width        fit the width of the article. It is recommended though to keep the width
394        of images approximately below 1200px, just to not waste too much repository space        of images approximately below 1200px, just to not waste too much repository space
# Line 501  Line 501 
501        Syntax highlighting is automatically generated for you. That way you don't        Syntax highlighting is automatically generated for 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 instead.        concentrate on the content of your article instead.
504        You should provide the intended programming with <code>??language??</code>.        You should provide the intended programming language of your source code sample
505        Obviously it is exhausting to provide such a <code lang="none">lang</code>        with <code>??language??</code>.
506        attribute with every single code sample, especially if you are just refering        Obviously it is exhausting to supply such a <code lang="none">lang</code>
507        a single code token within your paragraphs. So you don't have to do that.        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        If you omit the <code lang="none">lang</code> attribute, then our site's
510        software will automatically use the language defined by your with one of        software will automatically use the language defined by you with one of
511        the previous code blocks.        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>      </p>
515      <p>      <p>
516        Like with images, you can        Like with images, you can
# Line 520  Line 523 
523        <ul>        <ul>
524          <li><a href="nksp.html">NKSP real-time instrument script language</a></li>          <li><a href="nksp.html">NKSP real-time instrument script language</a></li>
525          <li>HTML markup language</li>          <li>HTML markup language</li>
526            <li><a href="sfz.html">SFZ File Format</a></li>
527        </ul>        </ul>
528        If you need another source code language, just tell        If you need another source code language, just tell
529        <a href="http://www.linuxsampler.org/developers.html#Schoenebeck">Christian</a>        <a href="http://www.linuxsampler.org/developers.html#Schoenebeck">Christian</a>
# Line 865  end on Line 869  end on
869        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"
870        attribute of the note tag.        attribute of the note tag.
871      </p>      </p>
872        
873        <h2>Directory Listings</h2>
874        <p>
875          Software components often have a certain kind of directory structure.
876          For readers of your articles is it way easier to perceive directory
877          structures if they are displayed in a visual appropriate way. There are
878          two specials tags you can use for this purpose:
879        </p>
880        <code lang="html">
881    &lt;dir&gt;/
882      &lt;dir&gt;home
883        &lt;dir&gt;bob
884          &lt;file&gt;README.txt&lt;/file&gt;
885          &lt;file&gt;foo.sh&lt;/file&gt;
886        &lt;/dir&gt;
887      &lt;/dir&gt;
888      &lt;dir&gt;tmp
889        &lt;file&gt;bla.tmp&lt;/file&gt;
890      &lt;/dir&gt;
891    &lt;/dir&gt;
892        </code>
893        <example>
894          <dir>/
895            <dir>home
896              <dir>bob
897                <file>README.txt</file>
898                <file>foo.sh</file>
899              </dir>
900            </dir>
901            <dir>tmp
902              <file>bla.tmp</file>
903            </dir>
904          </dir>
905        </example>
906        <p>
907          Currently for each file the same icon will be displayed. This might change
908          in future, i.e. a an automatic different icon could be picked by the
909          site's software according to the respective file name extension.
910        </p>
911    
912      <h2>Extensions</h2>      <h2>Extensions</h2>
913      <p>      <p>
914        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 881  end on Line 924  end on
924        You are at the end of our tour introducing our documentation system.        You are at the end of our tour introducing our documentation system.
925        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,
926        simply        simply
927        <a href="http://www.linuxsampler.org/developers.html">        <a href="http://www.linuxsampler.org/developers.html">send your article to some of us</a>,
928          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  
929        manage articles of our documentation site on your own.        manage articles of our documentation site on your own.
930      </p>      </p>
931      <p>      <p>
Legend:
Removed from v.2744  
changed lines
  Added in v.3083
  ViewVC Help
Powered by ViewVC