/[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 2747 by schoenebeck, Wed Apr 29 10:41:20 2015 UTC revision 2751 by schoenebeck, Wed Apr 29 11:20:57 2015 UTC
# 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 505  Line 505 
505        with <code>??language??</code>.        with <code>??language??</code>.
506        Obviously it is exhausting to supply such a <code lang="none">lang</code>        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        attribute with every single code sample, especially if you are just referring
508        a single code token within your paragraphs. So you don't have to do that.        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 you with one of        software will automatically use the language defined by you with one of
511        the previous code blocks. You may also disable automatic syntax highlighting        the previous code blocks. You may also disable automatic syntax highlighting
# Line 868  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
Legend:
Removed from v.2747  
changed lines
  Added in v.2751
  ViewVC Help
Powered by ViewVC