Edit page History

User Guide Layout Test

    This page should be used internally to discuss the new IJ user guide layout. Once polished, it should serve to orient on when converting old user guide sections or preparing new sections to end up with a uniform layout.

    The syntax is always shown in the gray boxes and the actual look you will see directly below each syntax specification.

    If you want to add other templates, here you can find the ones existing on imagej.net: Template pages

    Different headline levels

    == 1 Main Menu Items ==     
    === 1.1 Submenus/Direct commands ===
    ==== 1.1.1 Sub-submenu ====
    ===== 1.1.1.1 Sub-submenu =====
    

    1 Main Menu Items

    1.1 Submenus/Direct commands

    1.1.1 Sub-submenu

    1.1.1.1 Sub-sub-submenu (if needed)

    Plugin parameters

    Plugin parameters such as number fields, text fields, checkboxes, or radio buttons will be shown bold

    dropdown choices will be indeícated bold/italic

    Keyboard keys

    <code class="key">Ctrl</code>  + <code class="key">C</code>    or    <code class="key">Ctrl</code>  + <code class="key">Shift</code>  + <code class="key">F</code>
    

    Ctrl

    • C     /     Ctrl
    • Shift
    • F
    <span class="bc">Image  ›  Color  ›  Split Channels</span>
    

    Image › Color › Split Channels

    Boxes

    <div class="sidebox-right">
    

    </div>

    <div class="sidebox-right">
    <p>As a standard box for additional info.</p>
    

    </div>

    Tip:

    Press the L key to access ImageJ”s most useful feature: the [[Command Finder]].

    Tip:

    Press the L key to access ImageJ”s most useful feature: the Command Finder.

    This should display a notice box used for tipps.

    This should display a notice box used for tipps.

    Something critical like do not put Fiji in the Programm Files folder!

    Something critical like do not put Fiji in the Programm Files folder!

    <span class="include tech">TODO tech:  <code>{"content"=>"if necessary can be used for technical details."}</code></span>
    

    TODO tech: {"content"=>"if necessary can be used for technical details."}

    <span class="include fiji">TODO fiji:  <code>{"content"=>"To mention Fiji specific hints!"}</code></span>
    

    TODO fiji: {"content"=>"To mention Fiji specific hints!"}

    Specific Icons

    <center> <img src="/images/icons/no-red-x.png" style="width:30px;height:30px;">
    

    </center>

    Operating systems

    {% include linux content=’Everyone agrees: Linux is the ““best”” operating system!’ %}

    Everyone agrees: Linux is the ““best”” operating system!

    {% include windows content=’Everyone agrees: Windows is the ““best”” operating system!’ %}

    Everyone agrees: Windows is the ““best”” operating system!

    {% include macos content=’Everyone agrees: macOS is the ““best”” operating system!’ %}

    Everyone agrees: macOS is the ““best”” operating system!

    == TODO / Task list == The guidetask enables to make a tasklist with up to 10 entries. This could either be appended to the bottom of each article, or to article’s discussion page. We could use the Todo

    TODO guidetask: {"content"=>"\nadd link to wiki page|add info on shortcut <code class=\"key\">Shift\n + <code class="key">F</code>\n|mention alternative plugins\n”}</code></div>

    TODO guidetask: {"content"=>"\nadd link to wiki page\\|add info on usage of <code class=\"key\">Shift\n + <code class="key">F</code>\n\|mention alternative plugins\n”}</code></div>