72 Commits

Author SHA1 Message Date
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
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
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
Eric Lippmann
b79b337e02 Use Parsedown from the include path
refs #6165
refs #6166
2014-11-14 11:50:56 +01: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
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
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
Eric Lippmann
38a6df91b9 doc/DocParser: Rename 'chapterName' to 'chapterTitle'
refs #4820
2014-07-29 11:10:49 +02:00
Eric Lippmann
55d3818ebb doc/SectionRenderer: Support images
refs #4820
2014-07-29 11:10:06 +02:00
Eric Lippmann
788e3eb6fc doc: No longer use separate view scripts
refs #4820
2014-07-28 19:17:03 +02:00
Eric Lippmann
88312e6284 doc/lib: Add `SectionFilterIterator' for iterating over sections that are part of a particular chapter
refs #4820
2014-07-28 19:11:59 +02:00
Eric Lippmann
79f6130e3c doc/lib: Add SectionRenderer' for rendering instances of DocTree' as sections
refs #4820
2014-07-28 19:11:15 +02:00
Eric Lippmann
8a229e15ab doc/lib: Add TocRenderer' for rendering instances of DocTree' as toc
refs #4820
2014-07-28 19:10:40 +02:00
Eric Lippmann
0033733062 doc/lib: Add `Renderer' as base class for toc and section renderer
refs #4820
2014-07-28 19:09:55 +02:00
Eric Lippmann
134db3fc66 doc/DocParser: Replace getDoc()' and getToc()' with `getDocTree()'
refs #4820
2014-07-28 19:09:04 +02:00
Eric Lippmann
51bc0274f3 doc/lib: Add `DocTree' for representing a documentation as tree of sections
refs #4820
2014-07-28 19:06:12 +02:00
Eric Lippmann
c71086c748 doc/lib: Add `Section'
In the future a documentation will be represented as tree of sections.

refs #4820
2014-07-28 19:00:50 +02:00
Eric Lippmann
c325c09293 doc/DocIterator: Use `NonEmptyFileIterator'
Considering empty files makes no sense.

refs #4820
2014-07-28 18:59:42 +02:00
Eric Lippmann
4f8cbb99dd doc/lib: Add `NonEmptyFileIterator' for iterating over non-empty files
refs #4820
2014-07-28 18:58:46 +02:00
Eric Lippmann
71e81087b3 doc/ChapterNotFoundException: Remove unnecessary line breaks
refs #4820
2014-07-28 18:57:46 +02:00
Eric Lippmann
77f8a3d67d doc/DocEmptyException: Remove unnecessary line breaks
refs #4820
2014-07-28 18:55:54 +02:00
Eric Lippmann
a0c331020b doc/DocException: Extend RuntimeException' instead of Exception'
Errors in the documentation module can only be found on runtime.

refs #4820
2014-07-28 18:53:41 +02:00
Eric Lippmann
507ac1c4d7 doc/MarkdownFileIterator: Nail down PHPDoc
refs #4820
2014-07-28 18:52:25 +02:00
Eric Lippmann
e005333806 Merge branch 'master' into feature/display-documentation-4820 2014-07-22 12:25:58 +02:00
Johannes Meyer
3105c2059e Remove license headers from all files
refs #6309
2014-07-15 13:43:52 +02:00
Eric Lippmann
db5c6631d9 Merge branch 'master' into feature/display-documentation-4820
Conflicts:
	modules/doc/library/Doc/Controller.php
2014-07-01 12:42:55 +02:00
Eric Lippmann
1bbfa9b9ca doc module: Let DocParser' throw DocEmptyException' and `ChapterNotFound' exception
`DocEmptyException' is thrown during construction when a documentation directory is empty.
`ChapterNotFound' is thrown when a chapter was not found when calling `getChapter()'.

refs #4820
2014-06-30 15:24:40 +02:00
Eric Lippmann
c48f7f9fba doc module: Add `DocIterator::count()'
Method used to count available markdown documentation files.

refs #4820
2014-06-30 15:22:32 +02:00
Eric Lippmann
a8e6dda783 doc module: Add `DocEmptyException'
refs #4820
2014-06-30 15:21:35 +02:00
Eric Lippmann
0382e2265c doc module: Add `ChapterNotFoundException'
refs #4820
2014-06-30 15:21:16 +02:00
Eric Lippmann
93cc24a93a doc module: Move DocException' beneath Exception' namespace
There are more exceptions to come which also will be beneath the `Exception' namespace.

refs #4820
2014-06-30 15:18:22 +02:00
Thomas Gelf
b7fc0b67a8 Web/controllers: use own Request/Response objects
* introduces Icinga\Web\Response
* uses ModuleActionController where necessary
* no module translationDomain voodoo in base ActionController
2014-06-22 13:49:21 +02:00
Eric Lippmann
8fe1d49ce9 doc/cs: Begin additional if conditions on a new line 2014-06-13 17:23:20 +02:00
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