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
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
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
Eric Lippmann
83c12cfb2e
modules/doc: Add partial for displaying doc and toc
...
refs #4820
2014-05-27 15:11:32 +02:00
Eric Lippmann
a91961284d
modules/doc: Show nothing on index yet
...
Before, doc's IndexController::indexAction() showed the documentation
of Icinga Web 2 but index should rather show an overview of available
docs.
refs #4820
2014-05-27 15:11:32 +02:00
Thomas Gelf
d326b3b683
Get documentation module ready for release, first steps
2014-03-21 19:05:00 +00:00
Eric Lippmann
5a913881a6
Modules/Doc: Add Syntax highlighting for PHP code
...
refs #4820
2014-02-11 17:04:58 +01:00
Eric Lippmann
7f099b211b
Fix documentation
...
refs #4820
2014-02-11 16:35:36 +01:00
Eric Lippmann
1caacbf20f
Modules/Doc: Set rel="nofollow" on header links missing a user-specified id
...
refs #4820
2014-02-11 15:27:42 +01:00
Eric Lippmann
f96974fc79
Modules/Doc: Use Icinga\Web\Menu for the toc
...
refs #4820
2014-02-11 15:13:18 +01:00
Eric Lippmann
88e13c378d
Modules/Doc: Add doc display per module
...
refs #4820
2014-02-11 15:09:04 +01:00
Eric Lippmann
75577cec51
Modules/doc: Replace Michelf/Markdown with Parsedown
...
refs #4820
2014-02-11 15:09:03 +01:00
Eric Lippmann
af33599e19
Add doc module (WIP)
...
refs #4820
2014-02-11 15:09:03 +01:00