tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
8,269 Commits 116 Branches 71 Tags 80 MiB
Commit Graph

233 Commits

Author SHA1 Message Date
Eric Lippmann 9eb4b62cd0 doc: Register PDF route 
refs #4820
 2014-07-28 19:15:44 +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
Alexander Klimov 9af89e6ccf doc module: style h[1-6], table and code 
Headers have different sizes
Tables have borders
Table headers are left-aligned
Codes are displayed inline (except inside pre) and have scrollbars if necessary

refs #6484
fixes #6632
 2014-07-23 11:28:45 +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 2ea418cbe6 doc module: Respond with 404 if a chapter was not found or the doc directory is empty 
refs #4820
 2014-06-30 15:48:43 +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
Johannes Meyer 7eb0f3c472 Remove @codingStandardsIgnoreStart/-Stop annotations 
refs #6091
 2014-06-30 13:59:58 +02:00
Eric Lippmann e73471030c doc/modules/index: Only list modules which have the 'doc' directory 
refs #4820
 2014-06-30 11:43:25 +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 61ac3b0168 doc: Fix translation exceptions 
refs #6432
refs #4820
 2014-06-06 14:45:13 +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
Eric Lippmann 0f1983fb25 doc: Fix links in index view scripts 
refs #4820
 2014-05-28 17:24:28 +02:00
Eric Lippmann 49e927c4bf doc: Support `doc/module/:moduleName/toc' URLs 
refs #4820
 2014-05-28 17:19:48 +02:00
Eric Lippmann dc1bada56f doc: Add a view script for module's doc toc 
refs #4820
 2014-05-28 17:19:24 +02:00
Eric Lippmann 72ab5027b5 doc: Add view script for the toc of Icinga Web 2's doc 
refs #4820
 2014-05-28 17:18:57 +02:00
Eric Lippmann d3a9f17fc2 doc/parser: Return the DocTocHtmlRenderer instead of an array 
refs #4820
 2014-05-28 17:18:07 +02:00
Eric Lippmann 2f1303a13b doc: No longer use a partial for viewing a toc 
refs #4820
 2014-05-28 17:16:37 +02:00
Eric Lippmann f0b6a3557e doc/lib: Add DocTocHtmlRenderer class to render a toc to HTML 
refs #4820
 2014-05-28 17:15:43 +02:00
Eric Lippmann d2936d0338 doc/lib: Add DocToc class representing a toc 
refs #4820
 2014-05-28 17:15:08 +02:00
Eric Lippmann b11c0c36f9 Doc: Support `doc/icingaweb/chapter/:chapterName' URLs 
refs #4820
 2014-05-28 13:34:39 +02:00
Eric Lippmann 0f4d2ad80c Doc: Support `doc/module/:moduleName/chapter/:chapterName' URLs 
refs #4820
 2014-05-28 13:33:07 +02:00
Eric Lippmann 93ee8e0a3d Doc: Remove index/toc view script 
I see no reference to this file.

refs #4820
 2014-05-28 13:28:06 +02:00
Eric Lippmann 6159c05457 Doc: Fix IndexController not using `DocController' 
refs #4820
 2014-05-27 15:12:21 +02:00
Eric Lippmann 178402b65c Doc: Add action to view a chapter of a module's documentation 
Note that the FULL documentation is displayed yet.

refs #4820
 2014-05-27 15:12:21 +02:00
Eric Lippmann e78d98a607 Doc: Add action to display a chapter of Icinga Web 2's documentation 
Note that the FULL documentation is displayed yet.

refs #4820
 2014-05-27 15:12:21 +02:00
Eric Lippmann dad7dc9e6c Doc: Rename `DocController::renderDocAndToc()' to `renderChapter()' 
Prepare that every chapter is displayed on a new page.

refs #4820
 2014-05-27 15:12:21 +02:00
Eric Lippmann 282af5a794 Doc: Add `toc' view script 
refs #4820
 2014-05-27 15:12:21 +02:00
Eric Lippmann e320d8613c Doc: Rename `docandtoc' view script to `chapter' 
Prepare that every chapter is displayed on a new page.

refs #4820
 2014-05-27 15:12:21 +02:00
Eric Lippmann 0f5e076771 Doc: Add action to view the toc of a module's documentation 
refs #4820
 2014-05-27 15:12:20 +02:00
Eric Lippmann dd6427019a Doc: Add action to render the toc of Icinga Web 2's documentation 
refs #4820
 2014-05-27 15:12:13 +02:00
Eric Lippmann 884e4c8e94 Doc: Add `DocController::renderToc()' method 
refs #4820
 2014-05-27 15:12:13 +02:00
Eric Lippmann 71615151a4 Doc: Rename `Controller' to `DocController' 
refs #4820
 2014-05-27 15:12:13 +02:00
Eric Lippmann 6ce739e23d Doc: Construct parser with the path to the documentation 
Before, the parser decided which path to used based on a given module name.
Now, the parser requires the path to the documentation.
Further the toc items no longer include a URL. The must URL must be generated
from a render function or view script.

refs #4820
 2014-05-27 15:12:06 +02:00
Eric Lippmann 5923622fb8 modules/doc: Fix toc links 
The DocParser generates toc links with a hard-coded URL. This should
be changed to be generated from a route. But we did not decide how
to handle route overrides yet.

refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann 1d5c4c5055 modules/doc: Add styles 
refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann 89bddb10e7 modules/doc: Tell which doc directory does not exist, in case it does not exist :) 
Thanks Michael

refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann 5627c09b37 modules/doc: Reduce tab size to two spaces in module/index.phtml 
refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann a40f34394b modules/doc: List available documentations on index 
refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann 4001f1de62 modules/doc: Remove module/view.phtml as it has been replaced by renderDocAndToc() 
refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann ba860edb75 modules/doc: Remove icingaweb/index.phtml since it's replaced by renderDocAndToc() 
refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann 40c2c64985 modules/doc: Implement doc/module/$moduleName URLs 
refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann 74ea4d19b8 modules/doc: Rename populateView() to renderDocAndToc() 
Rename populateView() to renderDocAndToc() since the method now sets the viewHelper
to docandtoc.phtml

refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann 99971e241c modules/doc: Replace Parsedown's decprecated method parse() with text() 
refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann ce37c20736 modules/doc: Add route 'modules/doc/icingaweb' to display Icinga Web 2's documentation 
refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann e6abe21fb8 modules/doc: Rename DocParser::getDocumentation() to getDocAndToc() 
refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann 83c12cfb2e modules/doc: Add partial for displaying doc and toc 
refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann a91961284d modules/doc: Show nothing on index yet 
Before, doc's IndexController::indexAction() showed the documentation
of Icinga Web 2 but index should rather show an overview of available
docs.

refs #4820
 2014-05-27 15:11:32 +02:00
Thomas Gelf d326b3b683 Get documentation module ready for release, first steps 2014-03-21 19:05:00 +00:00
Eric Lippmann 5a913881a6 Modules/Doc: Add Syntax highlighting for PHP code 
refs #4820
 2014-02-11 17:04:58 +01:00
Eric Lippmann 7f099b211b Fix documentation 
refs #4820
 2014-02-11 16:35:36 +01:00
Eric Lippmann 1caacbf20f Modules/Doc: Set rel="nofollow" on header links missing a user-specified id 
refs #4820
 2014-02-11 15:27:42 +01:00
Eric Lippmann f96974fc79 Modules/Doc: Use Icinga\Web\Menu for the toc 
refs #4820
 2014-02-11 15:13:18 +01:00
Eric Lippmann 88e13c378d Modules/Doc: Add doc display per module 
refs #4820
 2014-02-11 15:09:04 +01:00
Eric Lippmann 75577cec51 Modules/doc: Replace Michelf/Markdown with Parsedown 
refs #4820
 2014-02-11 15:09:03 +01:00
Eric Lippmann af33599e19 Add doc module (WIP) 
refs #4820
 2014-02-11 15:09:03 +01:00