2075 Commits

Author SHA1 Message Date
Eric Lippmann
16d5d65a05 doc: Fix actions and view scripts DocParser usage
refs #4820
2014-06-06 14:12:32 +02:00
Eric Lippmann
d446e0db2e doc: Implement DocParser::getChapter()
refs #4820
2014-06-06 14:12:30 +02:00
Eric Lippmann
07330c1ca9 doc: Don't use absolute 'use' in MarkdownFileIterator
refs #4820
2014-06-06 14:12:27 +02:00
Eric Lippmann
625a6dae40 doc: Remove DocTocHtmlRenderer as it's superseded by Data/Tree/NodeRenderer
refs #4820
2014-06-06 14:12:22 +02:00
Eric Lippmann
cf987544c5 doc: Remove class DocToc as it's superseded by Data/Tree/Node
refs #4820
2014-06-06 14:12:13 +02:00
Eric Lippmann
6c8d35c667 lib: Add a not yet customizable node renderer 2014-06-06 13:58:40 +02:00
Eric Lippmann
ce0aee5e41 lib: Add Data/Tree/Node.php 2014-06-06 13:58:14 +02:00
Eric Lippmann
d84532d593 lib: Remove TreeIterator
Nodes implementing the NodeInterface (which extends the RecursiveIterator interface)
are already iterable.
2014-06-06 13:57:18 +02:00
Eric Lippmann
794ae141fa lib: Let NodeInterface extend RecursiveIterator
Since a node may have children and they should be iterable, the Nodefinterface
now extends RecursiveIterator.
2014-06-06 13:55:58 +02:00
Eric Lippmann
d5cf2f2472 doc: Implement `DocParser::getToc()'
refs #4820
2014-06-03 15:23:59 +02:00
Eric Lippmann
ed8de18ad5 DocParser: Use first header in a file as section title
refs #4820
2014-06-03 14:56:44 +02:00
Eric Lippmann
370bfca6e6 DocParser: Remove itemPriority since it's nowhere used
refs #4820
2014-06-03 14:53:28 +02:00
Eric Lippmann
0f1983fb25 doc: Fix links in index view scripts
refs #4820
2014-05-28 17:24:28 +02:00
Eric Lippmann
49e927c4bf doc: Support `doc/module/:moduleName/toc' URLs
refs #4820
2014-05-28 17:19:48 +02:00
Eric Lippmann
dc1bada56f doc: Add a view script for module's doc toc
refs #4820
2014-05-28 17:19:24 +02:00
Eric Lippmann
72ab5027b5 doc: Add view script for the toc of Icinga Web 2's doc
refs #4820
2014-05-28 17:18:57 +02:00
Eric Lippmann
d3a9f17fc2 doc/parser: Return the DocTocHtmlRenderer instead of an array
refs #4820
2014-05-28 17:18:07 +02:00
Eric Lippmann
2f1303a13b doc: No longer use a partial for viewing a toc
refs #4820
2014-05-28 17:16:37 +02:00
Eric Lippmann
f0b6a3557e doc/lib: Add DocTocHtmlRenderer class to render a toc to HTML
refs #4820
2014-05-28 17:15:43 +02:00
Eric Lippmann
d2936d0338 doc/lib: Add DocToc class representing a toc
refs #4820
2014-05-28 17:15:08 +02:00
Eric Lippmann
9edaaa82e8 lib: Add TreeIterator 2014-05-28 17:14:33 +02:00
Eric Lippmann
040473f986 lib: Add NodeInterface 2014-05-28 17:13:42 +02:00
Eric Lippmann
b11c0c36f9 Doc: Support `doc/icingaweb/chapter/:chapterName' URLs
refs #4820
2014-05-28 13:34:39 +02:00
Eric Lippmann
0f4d2ad80c Doc: Support `doc/module/:moduleName/chapter/:chapterName' URLs
refs #4820
2014-05-28 13:33:07 +02:00
Eric Lippmann
c12c4a9e4c Modules: Call `Module::registerWebIntegration()' after including the run script
Routes added via a module's run script were not respected since
`Module::registerRoutes()' is called from `Module::registerWebIntegration()'.

refs #6303
2014-05-28 13:29:02 +02:00
Eric Lippmann
93ee8e0a3d Doc: Remove index/toc view script
I see no reference to this file.

refs #4820
2014-05-28 13:28:06 +02:00
Eric Lippmann
6159c05457 Doc: Fix IndexController not using `DocController'
refs #4820
2014-05-27 15:12:21 +02:00
Eric Lippmann
178402b65c Doc: Add action to view a chapter of a module's documentation
Note that the FULL documentation is displayed yet.

refs #4820
2014-05-27 15:12:21 +02:00
Eric Lippmann
e78d98a607 Doc: Add action to display a chapter of Icinga Web 2's documentation
Note that the FULL documentation is displayed yet.

refs #4820
2014-05-27 15:12:21 +02:00
Eric Lippmann
dad7dc9e6c Doc: Rename DocController::renderDocAndToc()' to renderChapter()'
Prepare that every chapter is displayed on a new page.

refs #4820
2014-05-27 15:12:21 +02:00
Eric Lippmann
282af5a794 Doc: Add `toc' view script
refs #4820
2014-05-27 15:12:21 +02:00
Eric Lippmann
e320d8613c Doc: Rename docandtoc' view script to chapter'
Prepare that every chapter is displayed on a new page.

refs #4820
2014-05-27 15:12:21 +02:00
Eric Lippmann
0f5e076771 Doc: Add action to view the toc of a module's documentation
refs #4820
2014-05-27 15:12:20 +02:00
Eric Lippmann
dd6427019a Doc: Add action to render the toc of Icinga Web 2's documentation
refs #4820
2014-05-27 15:12:13 +02:00
Eric Lippmann
884e4c8e94 Doc: Add `DocController::renderToc()' method
refs #4820
2014-05-27 15:12:13 +02:00
Eric Lippmann
71615151a4 Doc: Rename Controller' to DocController'
refs #4820
2014-05-27 15:12:13 +02:00
Eric Lippmann
6ce739e23d Doc: Construct parser with the path to the documentation
Before, the parser decided which path to used based on a given module name.
Now, the parser requires the path to the documentation.
Further the toc items no longer include a URL. The must URL must be generated
from a render function or view script.

refs #4820
2014-05-27 15:12:06 +02:00
Eric Lippmann
b58ec5f445 Add Module::addRoute() to add a route to the route chain
refs #6303
2014-05-27 15:11:33 +02:00
Eric Lippmann
5923622fb8 modules/doc: Fix toc links
The DocParser generates toc links with a hard-coded URL. This should
be changed to be generated from a route. But we did not decide how
to handle route overrides yet.

refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
1d5c4c5055 modules/doc: Add styles
refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
89bddb10e7 modules/doc: Tell which doc directory does not exist, in case it does not exist :)
Thanks Michael

refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
5627c09b37 modules/doc: Reduce tab size to two spaces in module/index.phtml
refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
a40f34394b modules/doc: List available documentations on index
refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
4001f1de62 modules/doc: Remove module/view.phtml as it has been replaced by renderDocAndToc()
refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
ba860edb75 modules/doc: Remove icingaweb/index.phtml since it's replaced by renderDocAndToc()
refs #4820
2014-05-27 15:11:33 +02:00
Eric Lippmann
40c2c64985 modules/doc: Implement doc/module/$moduleName URLs
refs #4820
2014-05-27 15:11:32 +02:00
Eric Lippmann
74ea4d19b8 modules/doc: Rename populateView() to renderDocAndToc()
Rename populateView() to renderDocAndToc() since the method now sets the viewHelper
to docandtoc.phtml

refs #4820
2014-05-27 15:11:32 +02:00
Eric Lippmann
99971e241c modules/doc: Replace Parsedown's decprecated method parse() with text()
refs #4820
2014-05-27 15:11:32 +02:00
Eric Lippmann
ce37c20736 modules/doc: Add route 'modules/doc/icingaweb' to display Icinga Web 2's documentation
refs #4820
2014-05-27 15:11:32 +02:00
Eric Lippmann
e6abe21fb8 modules/doc: Rename DocParser::getDocumentation() to getDocAndToc()
refs #4820
2014-05-27 15:11:32 +02:00