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
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