Commit Graph

164 Commits

Author SHA1 Message Date
Eric Lippmann 4931418c03 doc/lib: Pass highlight-search parameter to the renderer
refs #6630
2015-02-11 13:21:01 +01:00
Eric Lippmann 57ca11cb76 doc/lib: Highlight search when displaying a chapter
refs #6630
2015-02-11 13:20:30 +01:00
Eric Lippmann 512eb3fe83 doc/lib: Remove DocSearchRenderer::highlight()
refs #6630
2015-02-11 13:16:55 +01:00
Eric Lippmann ab78757483 doc/lib: Add DocSearchMatch::highlight()
refs #6630
2015-02-11 13:16:49 +01:00
Eric Lippmann 1053e62e20 doc/lib: Fix DocSearchIterator::count() counting too many
Because DocSearchIterator is a recursive filter iterator and we accept
any hode having children, those children not matching any of the search criteria
were counted too because of iterator_count.

refs #6630
2015-02-11 13:03:46 +01:00
Eric Lippmann 21b65d8079 doc/lib: Show trace in case an exception is thrown during rendering
refs #6630
2015-02-11 13:03:01 +01:00
Eric Lippmann d2520f1286 doc/lib: Prefer @type over @var in the DocParser
refs #6630
2015-02-11 13:02:33 +01:00
Eric Lippmann bd71dbdbdc doc/lib: Rearrange imports in the DocIterator
refs #6630
2015-02-11 13:02:04 +01:00
Eric Lippmann 0b1a9c1659 doc/lib: Apply role and css class toc to the toc
refs #6630
2015-02-11 12:58:31 +01:00
Eric Lippmann e2b34023cd doc/lib: Add SearchController
At the moment only Icinga Web 2's documentation is available for searching.

refs #6630
2015-02-10 17:14:16 +01:00
Eric Lippmann 3b20e49940 doc/lib: Add renderer for doc searches
refs #6630
2015-02-10 17:13:17 +01:00
Eric Lippmann e7b0f8d30f doc/lib: Add iterator over doc sections that match a given search criteria
refs #6630
2015-02-10 17:12:43 +01:00
Eric Lippmann 267c36d8d1 doc/lib: Add class DocSearchMatch represeting a search match
refs #6630
2015-02-10 17:11:48 +01:00
Eric Lippmann 312d18d14a doc/lib: Add DocSearch class for creating search criteria
refs #6630
2015-02-10 17:11:00 +01:00
Eric Lippmann 005ef8c92f doc/lib: Update controllers and views according to the recent changes
refs #6630
2015-02-10 17:09:56 +01:00
Eric Lippmann 41355fe0e2 doc/lib: Drop navigation added to each section
refs #6630
2015-02-10 17:08:48 +01:00
Eric Lippmann 5965638e23 doc/lib: Open toc links in the next container
refs #6630
2015-02-10 17:07:24 +01:00
Eric Lippmann 52de56fb65 doc/lib: Use TreeNodeIterator in the SectionFilterIterator
refs #6630
2015-02-10 17:06:11 +01:00
Eric Lippmann 9093795f64 doc/lib: Add common used methods to the abstract Renderer
refs #6630
2015-02-10 17:05:24 +01:00
Eric Lippmann 377685d802 doc/lib: Let DocException extend IcingaException 2015-02-10 17:04:46 +01:00
Eric Lippmann c95838a33d doc/lib: Use SimpleTree in the DocParser
refs #6630
2015-02-10 17:04:27 +01:00
Eric Lippmann 9f3b953165 doc/lib: Support setting the chapter a section belongs to
refs #6630
2015-02-10 17:03:58 +01:00
Eric Lippmann 07cfbe23ef doc/lib: Use @inheritdoc in the DocIterator 2015-02-10 17:03:15 +01:00
Eric Lippmann b2ace4e209 doc: Remove DocTree class
It will be replaced by a class in our lib

refs #6630
2015-02-10 16:58:40 +01:00
Eric Lippmann ecfda1a6f5 lib/doc: Rename Section to DocSection and let it extend TreeNode
refs #6630
2015-02-06 17:29:04 +01:00
Eric Lippmann 95c937e3fd lib/doc: Fix code style for doc exceptions 2015-02-06 17:24:01 +01:00
Eric Lippmann 6bae2e0a53 Note that our license is GPL v2 or any later version in our license header instead of pointing to the license's URL 2015-02-04 10:52:27 +01:00
Eric Lippmann 5b4fab0750 Add license header
This time without syntax errors hopefully :)
2015-02-03 16:27:59 +01:00
Eric Lippmann 5fa2e3cfdc Revert "Add license header"
This reverts commit 338d067aba.
2015-02-03 16:16:26 +01:00
Eric Lippmann 338d067aba Add license header
fixes #7788
2015-02-03 15:51:04 +01:00
Eric Lippmann 5fe5e22395 doc: Support any link having a fragment except http(s) links for linking between headings 2015-01-23 16:00:15 +01:00
Eric Lippmann bca2335aa3 doc: Add module documentation 2014-12-09 14:58:18 +01:00
Eric Lippmann d2a7254a37 doc: Prefer "root" doc path over configured path
If the "root" doc path, i.e. application/doc exists, it is preferred over the configured
one.

refs #4075
2014-12-09 14:55:24 +01:00
Eric Lippmann 3120a0c090 doc/ModuleController: Do not use 'void' results 2014-12-09 14:30:57 +01:00
Eric Lippmann c7e6252aca doc: Make path to module documentations configureable
refs #7196
2014-12-09 14:30:10 +01:00
Eric Lippmann e901e545c3 doc/IcingawebController: Do not use 'void' results 2014-12-09 14:28:58 +01:00
Eric Lippmann 7605076dc5 doc/IcingawebController: Use sprintf for "Missing parameter x" exceptions 2014-12-09 14:28:10 +01:00
Eric Lippmann 08bbe59679 doc: Throw an exception if Icinga Web 2's documentation is not avaiable
refs #7196
2014-12-09 14:27:02 +01:00
Eric Lippmann 823d338f73 doc/Controller: Do not use 'void' results 2014-12-09 14:24:45 +01:00
Eric Lippmann 40b7098480 doc/parser: Fix PHPDoc indentation 2014-12-09 14:24:11 +01:00
Eric Lippmann 7edb1217c6 doc: Use sprintf for "Missing parameter x" exceptions 2014-12-09 12:57:16 +01:00
Eric Lippmann 51b47df4c5 doc: Set version to 2.0.0 2014-12-09 12:55:29 +01:00
Eric Lippmann da575910e6 doc/run.php: Remove superfluous newline 2014-12-09 12:54:41 +01:00
Eric Lippmann cc619e0a7b doc/configuration.php: Prefer @type over @var 2014-12-09 12:53:44 +01:00
Eric Lippmann ca8dbdb938 doc: Make path to Icinga Web 2's doc configureable
refs #7196
2014-12-09 12:50:29 +01:00
Eric Lippmann 001eba73e7 doc: Remove iterators because they are superseded by iterators from Icinga Web 2's library 2014-12-09 12:30:08 +01:00
Eric Lippmann 5f772c3620 doc: Use Icinga Web 2's iterators 2014-12-09 12:29:48 +01:00
Thomas Gelf dad2aab482 doc/style: fix tab activation 2014-11-20 17:25:58 +01:00
Eric Lippmann 55d6a96fdc doc: Style tables, pre > code and code 2014-11-20 15:52:47 +01:00
Eric Lippmann a7b16bc4a2 doc: Don't use $this->_helper->viewRenderer
This somehow breaks our postDispatch logic. But $this->render does not.
2014-11-20 15:29:46 +01:00