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

288 Commits

Author SHA1 Message Date
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
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 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