Johannes Meyer
de744fdc83
Add proper title to each module documentation link
...
refs #8458
2015-02-23 17:17:48 +01:00
Johannes Meyer
49e7964355
Use an already existing variable instead of calling a function twice..
2015-02-23 17:13:55 +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   and too greedy regex
2015-02-12 10:24:55 +01:00
Eric Lippmann
8e7faa8170
doc/lib: Use <h1> for search headings
...
refs #6630
2015-02-11 15:53:41 +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
6c6c41a4f2
doc/lib: Remove controls from the search view script
...
Otherwise the dashboard is broken when searching.
refs #6630
2015-02-11 14:05:32 +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
16d388f4e3
doc/lib: Use CSS classes controls and content in the view scripts
2015-02-11 13:58:55 +01:00
Eric Lippmann
e26154e88a
doc/lib: Remove unused less mixins
2015-02-11 13:58:39 +01:00
Eric Lippmann
27c53a315f
doc/lib: Add missing search view script
...
refs #6630
2015-02-11 13:58:22 +01:00
Eric Lippmann
f33b6a918c
doc/lib: Remove unused view scripts
2015-02-11 13:58:06 +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
6f1fdad9c2
doc/lib: Add CSS for highlighting search results
...
refs #6630
2015-02-11 13:27:04 +01:00
Eric Lippmann
fa37f84cac
doc/lib: Search in module documentations too
...
refs #6630
2015-02-11 13:22:27 +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
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
Thomas Gelf
f43976a19a
css: centralize heading styles
2014-11-17 16:54:29 +01:00
Thomas Gelf
9e4cdd4470
doc/configuration: link to style guide
2014-11-17 16:53:46 +01:00
Thomas Gelf
add0667550
doc/style: add style guide, rename webfont
2014-11-17 16:53:14 +01:00
Thomas Gelf
56b00d3d58
doc/styles: add tabs, more to come
2014-11-17 10:39:25 +01:00
Thomas Gelf
da47c7fc7e
Merge remote-tracking branch 'origin/master' into feature/redesign-7144
2014-11-14 21:32:57 +01:00
Eric Lippmann
b79b337e02
Use Parsedown from the include path
...
refs #6165
refs #6166
2014-11-14 11:50:56 +01:00
Thomas Gelf
508466d8a1
doc/module.info: sample meta data
2014-11-14 08:46:26 +01:00
Bernd Erk
20be45e8da
Enable icon font
2014-11-13 20:08:58 +01:00
Thomas Gelf
c68f9502ea
modules/doc: restructure menu
...
Moved first hierarchy into the menu, added font style link
refs #6936
2014-11-13 15:57:39 +01:00
Thomas Gelf
3343599a63
doc/style: show web font icon set
...
refs #6936
2014-11-13 15:54:31 +01:00
Marius Hein
f694b16092
Doc/IcingaWebController: Fix "The ... with non-compound name ... has no effect"
2014-09-04 14:53:00 +02:00
Marius Hein
4c88abcb3c
Doc/ModuleController: Fix "The ... with non-compound name ... has no effect"
2014-09-04 14:49:58 +02:00
Alexander Fuhr
bb0e1dc105
Revert "Fixes unaccepted behavior in module configuration"
...
This reverts commit 236d384bab
.
2014-09-02 10:23:41 +02:00
Alexander Klimov
7ff51caed0
Remove leading backslashes from the targets of use statements
...
- use \Exception;
+ use Exception;
2014-08-27 15:51:49 +02:00
Alexander Fuhr
236d384bab
Fixes unaccepted behavior in module configuration
...
fixes #7011
2014-08-27 14:57:08 +02:00
Eric Lippmann
1dea19504f
Revert "Remove leading backslashes from the targets of use statements"
...
This reverts commit 87a5967501
.
At least 'modules/doc/run.php' issues a warning about "The use statement with non-compound name 'Zend_Controller_Router_Route' has no effect"
2014-08-27 12:24:11 +02:00
Alexander Klimov
87a5967501
Remove leading backslashes from the targets of use statements
...
- use \Exception;
+ use Exception;
2014-08-27 11:16:44 +02:00
Alexander Fuhr
968fa0a1cc
Add configuration.php to Doc Module
...
refs #6639
2014-08-22 11:02:08 +02:00
Eric Lippmann
8c02f140c3
doc: fix translate calls w/ sprintf
2014-08-19 16:22:54 +02:00
Eric Lippmann
55b3a5384a
doc: set page title
...
refs #4820
2014-08-19 13:38:18 +02:00
Eric Lippmann
d35e0816c9
doc: use `sprintf' in exceptions
...
refs #4820
2014-08-19 13:20:46 +02:00
Eric Lippmann
127e4f444f
doc: show prev chapter, index and next chapter links
...
refs #4820
2014-08-19 11:30:56 +02:00
Eric Lippmann
5c52e447f5
doc: upper case first character of a documentation's title
...
refs #4820
2014-08-19 10:26:38 +02:00
Eric Lippmann
cb17590b71
doc: rename `nofollow' to `noFollow'
...
refs #4820
2014-08-19 09:57:22 +02:00
Eric Lippmann
289aed8420
doc: Use `chapterId' instead of `chapterTitle' in URLs
...
Manually given chapter IDs are meant to not change while a chapter's title could change.
refs #4820
2014-08-19 09:45:53 +02:00
Eric Lippmann
f9e8ad3d0b
doc: Remove 'locale' directory
...
Since #6432 has been fixed, the empty locale directory can be removed.
refs #4820
2014-07-29 11:45:16 +02:00
Eric Lippmann
f6b9b13654
doc: Rename 'chapterName' to 'chapterTitle'
...
refs #4820
2014-07-29 11:19:40 +02:00
Eric Lippmann
3cafc8910a
doc/DocParser: Rename 'header' to 'title'
...
refs #4820
2014-07-29 11:12:06 +02:00