Fix documentation

refs #4820

application/views/scripts/layout/menu.phtml

@@ -1,5 +1,4 @@
-<ul>
-<?= $sub ? '<ul>' : '<ul class="nav nav-stacked" role="navigation" id="icinganavigation">' ?>
+<?= $sub ? '<ul>' : '<ul class="nav nav-stacked">' ?>
     <?php foreach ($items as $item): ?>
         <?php
         $itemClass = '';
@@ -16,7 +15,7 @@
             <?php endif; ?>
             <?php
             if ($icon = $item->getIcon()) {
-                echo $this->img($icon, array('height' => '16px', 'width' => '16px'));
+                echo $this->img($icon, array('height' => 16, 'width' => 16));
             }
             ?>
             <?php if ($iconClass = $item->getIconClass()): ?>

doc/components.md

@@ -95,7 +95,7 @@ with right time-format available.
 ### Component ids
 
 When an ID is assigned to the HTML element, it will be used by the component loader to reference this
-component. Otherwise an ID in the form "icinga-component-<ID>" will be created and the ID attribute in the
+component. Otherwise an ID in the form "icinga-component-&lt;ID&gt;" will be created and the ID attribute in the
 HTML Element will be updated accordingly.
 
 

doc/dashboard.md

@@ -40,4 +40,4 @@ By default, the config/dashboard/dashboard.ini is used for storing dashboards in
     url = "/monitoring/show/host/host1" ; ...and define it's url
 
 
-[dashboards1]: res/Dashboard.png
+[dashboards1]: res/Dashboard.png

doc/form.md

@@ -73,15 +73,15 @@ code from special directories:
 <table>
     <tr>
         <th>Class name</th>
-        <th>File path</tg>
+        <th>File path</th>
     </tr>
     <tr>
         <td>\Icinga\Form\Test\MyForm</td>
-        </td>application/forms/Test/MyForm.php</td>
+        <td>application/forms/Test/MyForm.php</td>
     </tr>
     <tr>
         <td>\MyModule\Form\Test</td>
-        </td>modules/forms/Test.php</td>
+        <td>modules/forms/Test.php</td>
     </tr>
 </table>
 
@@ -219,4 +219,4 @@ request dummy which can be passed to your form.
 * [Zend API documentation](http://framework.zend.com/apidoc/1.10/_Form.html#Zend_Form)
 
 
-[form1]: res/Form.png
+[form1]: res/Form.png

doc/form_elements.md

@@ -101,7 +101,7 @@ is a timestamp. The above DateTimePicker utilizes this validator and should be u
 ### ConditionalHidden Decorator
 
 The `Icinga\Web\Form\Decorator\ConditionalHidden` allows you to hide a form element with the 'conditional' attribute for
-users that don't have JavaScript enabled (the form is rendered in a \<noscript> tag when conditional is 1). Users with
+users that don't have JavaScript enabled (the form is rendered in a &lt;noscript&gt; tag when conditional is 1). Users with
 javascript won't see the elements, users with javascript will see it. This is useful in a lot of cases to allow icingaweb
 to be fully functional without JavaScript: Forms can show only sensible forms for most users (and, for example hide the
 debug log filepath input when debugging is disabled) and automatically reload the form as soon as the forms should be
@@ -133,6 +133,6 @@ the 'helptext' property in your form elements.
 ### BootstrapForm Decorator
 
 `Icinga\Web\Form\Decorator\BoostrapForm` is the decorator we use for our forms.
-It causes the forms to be rendered in a bootstrap friendly manner instead of the \<dd> \<dt> encapsulated way Zend normally
+It causes the forms to be rendered in a bootstrap friendly manner instead of the &lt;dd&gt; &lt;dt&gt; encapsulated way Zend normally
 renders the forms. You usually don't have to work with this decorator as our Form implementation automatically uses it,
 but it's always good to know why forms look how they look.

doc/installation.md

@@ -72,7 +72,7 @@ create all database tables. You will find the installation guides for the differ
 
 > **Note**
 >
-> RPM packages install the schema into /usr/share/doc/icingaweb-<version>/schema
+> RPM packages install the schema into /usr/share/doc/icingaweb-&lt;version&gt;/schema
 
    bash$  mysql -u root -p icingaweb < etc/schema/accounts.mysql.sql
 
@@ -105,7 +105,7 @@ And restart your database ('service postgresql restart' or '/etc/init.d/postgres
 
 > **Note**
 >
-> RPM packages install the schema into /usr/share/doc/icingaweb-<version>/schema
+> RPM packages install the schema into /usr/share/doc/icingaweb-&lt;version&gt;/schema
 
     bash$  psql -U icingaweb -a -f etc/schema/accounts.pgsql.sql
 

modules/doc/library/Doc/DocParser.php

@@ -70,6 +70,7 @@ class DocParser
             'level' => 0,
             'item'  => new Menu('doc')
         ));
+        $itemPriority = 1;
         foreach ($fileInfos as $fileInfo) {
             try {
                 $fileObject = $fileInfo->openFile();
@@ -79,8 +80,7 @@ class DocParser
             if ($fileObject->flock(LOCK_SH) === false) {
                 throw new DocException('Couldn\'t get the lock');
             }
-            $itemPriority   = 1;
-            $line           = null;
+            $line = null;
             while (!$fileObject->eof()) {
                 // Save last line for setext-style headers
                 $lastLine   = $line;
@@ -100,7 +100,7 @@ class DocParser
                         $id             = implode('-', $path);
                         $attribs['rel'] = 'nofollow';
                     }
-                    $id     = str_replace('.', '.', strip_tags($id));
+                    $id     = urlencode(str_replace('.', '.', strip_tags($id)));
                     $item   = end($toc)->item->addChild(
                         $id,
                         array(
@@ -109,7 +109,7 @@ class DocParser
                                 array(
                                     'name' => $this->module
                                 )
-                            )->setAnchor(urlencode($id))->getRelativeUrl(),
+                            )->setAnchor($id)->getRelativeUrl(),
                             'title'     => htmlspecialchars($header),
                             'priority'  => $itemPriority++,
                             'attribs'   => $attribs