Commit Graph

120 Commits

Author SHA1 Message Date
Eric Lippmann f1a63a36f5 doc: Support header-less sections 2015-08-11 09:20:56 +02:00
Eric Lippmann 82d36e11cc doc: Replace whitespaces with - for section IDs
Fixes jQuery selector issues when jumping to an anchor.
2015-08-11 09:20:56 +02:00
Eric Lippmann 4e3fbb1341 doc: Support setext-style only headers
Setext-style used to work before too but only if an atx-style header comes first.
2015-08-11 09:20:56 +02:00
Eric Lippmann 5ae21fd196 doc: Set parameters from route explicitly
refs #9817
2015-08-04 12:48:53 +02:00
Alexander A. Klimov 20b09d3bda Inherit from Icinga\Web\Controller rather than from Icinga\Web\Controller\ModuleActionController 2015-04-08 15:13:59 +02:00
Eric Lippmann 8563d5ed3f PHPDoc: Use @var instead of @type
Becasue of too many kittens PSR-5 backed off of deprecating @var.
So that's the way we go too.
2015-03-12 16:08:47 +01:00
Johannes Meyer a1e7cd8906 Add proper titles to the documentation tocs and search results
refs #8458
2015-02-23 17:12:34 +01:00
Eric Lippmann f00f598014 doc/lib: Fix undefined entity &nbsp and too greedy regex 2015-02-12 10:24:55 +01:00
Eric Lippmann fdec27d8a1 doc/lib: Remove DocSearchIterator::count()
refs #6630
2015-02-11 15:53:23 +01:00
Eric Lippmann 53af279ec2 doc/lib: Fix search criteria not splitting "complex" search strings correctly
refs #6630
2015-02-11 15:52:08 +01:00
Eric Lippmann 310201eb5b doc/lib: Throw LogicException if text is added without having a heading 2015-02-11 15:51:31 +01:00
Eric Lippmann 57a0b0005e doc/lib: Fix PDF rendering
refs #6630
2015-02-11 15:15:37 +01:00
Eric Lippmann 03100b8c59 doc/lib: Move all renderer classes to the renderer namespace
refs #6630
2015-02-11 14:10:12 +01:00
Eric Lippmann d1aed4f773 doc/lib: Rename SectionFilterIterator to DocSectionFilterIterator
refs #6630
2015-02-11 14:06:41 +01:00
Eric Lippmann 924e67f2aa doc/lib: Rename Renderer to DocRenderer
refs #6630
2015-02-11 14:05:18 +01:00
Eric Lippmann 3aff91d204 doc/lib: Rename TocRenderer to DocTocRenderer
refs #6630
2015-02-11 14:02:12 +01:00
Eric Lippmann 96ea02e59f doc/lib: Rename SectionRenderer to DocSectionRenderer
refs #6630
2015-02-11 14:01:19 +01:00
Eric Lippmann 195aa581cb doc/lib: Fix that highlighting a search messes up the text around the match
refs #6630
2015-02-11 13:48:23 +01:00
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 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 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