From d326b3b683db46edb1f41aa71876fd669a09c2b7 Mon Sep 17 00:00:00 2001 From: Thomas Gelf Date: Fri, 21 Mar 2014 19:05:00 +0000 Subject: [PATCH] Get documentation module ready for release, first steps --- .../controllers/IndexController.php | 19 ++++++++++++++++++ .../application/views/scripts/index/toc.phtml | 14 +++++++++++++ .../views/scripts/module/index.phtml | 2 +- .../views/scripts/module/view.phtml | 20 +++---------------- modules/doc/library/Doc/DocParser.php | 12 +++++------ 5 files changed, 43 insertions(+), 24 deletions(-) create mode 100644 modules/doc/application/views/scripts/index/toc.phtml diff --git a/modules/doc/application/controllers/IndexController.php b/modules/doc/application/controllers/IndexController.php index 9e7a63a95..299ae5c65 100644 --- a/modules/doc/application/controllers/IndexController.php +++ b/modules/doc/application/controllers/IndexController.php @@ -5,8 +5,27 @@ use Icinga\Module\Doc\Controller as DocController; +use Icinga\Module\Doc\DocParser; + class Doc_IndexController extends DocController { + protected $parser; + + + public function init() + { + $module = null; + $this->parser = new DocParser($module); + } + + + public function tocAction() + { + // Temporary workaround + list($html, $toc) = $this->parser->getDocumentation(); + $this->view->toc = $toc; + } + /** * Display the application's documentation */ diff --git a/modules/doc/application/views/scripts/index/toc.phtml b/modules/doc/application/views/scripts/index/toc.phtml new file mode 100644 index 000000000..9188e21ff --- /dev/null +++ b/modules/doc/application/views/scripts/index/toc.phtml @@ -0,0 +1,14 @@ +
+

Module documentations

+
+
+partial( + 'layout/menu.phtml', + 'default', + array( + 'items' => $toc->getChildren(), + 'sub' => false, + 'url' => '' + ) +) ?> +
diff --git a/modules/doc/application/views/scripts/module/index.phtml b/modules/doc/application/views/scripts/module/index.phtml index 3096e4517..36f11e15e 100644 --- a/modules/doc/application/views/scripts/module/index.phtml +++ b/modules/doc/application/views/scripts/module/index.phtml @@ -3,4 +3,4 @@
  • - \ No newline at end of file + diff --git a/modules/doc/application/views/scripts/module/view.phtml b/modules/doc/application/views/scripts/module/view.phtml index bcd894e65..291947ad7 100644 --- a/modules/doc/application/views/scripts/module/view.phtml +++ b/modules/doc/application/views/scripts/module/view.phtml @@ -1,21 +1,7 @@

    No documentation available.

    -
    -
    - partial( - 'layout/menu.phtml', - 'default', - array( - 'items' => $toc->getChildren(), - 'sub' => false, - 'url' => '' - ) - ); - ?> -
    -
    - -
    +
    +
    - \ No newline at end of file + diff --git a/modules/doc/library/Doc/DocParser.php b/modules/doc/library/Doc/DocParser.php index 46305e732..945a96eea 100644 --- a/modules/doc/library/Doc/DocParser.php +++ b/modules/doc/library/Doc/DocParser.php @@ -4,15 +4,15 @@ namespace Icinga\Module\Doc; -require_once 'vendor/Parsedown/Parsedown.php'; - -use \RecursiveIteratorIterator; -use \RecursiveDirectoryIterator; -use \Parsedown; +use RecursiveIteratorIterator; +use RecursiveDirectoryIterator; +use Parsedown; use Icinga\Application\Icinga; use Icinga\Web\Menu; use Icinga\Web\Url; +require_once 'vendor/Parsedown/Parsedown.php'; + /** * Parser for documentation written in Markdown */ @@ -119,7 +119,7 @@ class DocParser 'level' => $level, 'item' => $item )); - $line = '' . PHP_EOL . $line; + $line = '' . PHP_EOL . $line; } $cat[] = $line; }