Commit Graph

32 Commits

Author SHA1 Message Date
Eric Lippmann 160a75403d Merge branch 'master' into feature/display-documentation-4820
Conflicts:
	modules/doc/library/Doc/DocParser.php
2014-06-06 14:25:13 +02:00
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
Thomas Gelf c592236258 vendorlibs: library/vendor to libary/IcingaVendor
This doesn't make it much better but allows to build a package
libicinga-vendor-php placing those files to /usr/share/php/IcingaVendor
or similar.

refs #4075
2014-06-05 00:10:49 +00: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 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 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 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 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 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 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 e6abe21fb8 modules/doc: Rename DocParser::getDocumentation() to getDocAndToc()
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