63 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 338d067aba41dd6e9178cebec5433eecd614196e.
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
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
7edb1217c6 doc: Use sprintf for "Missing parameter x" exceptions 2014-12-09 12:57:16 +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
Thomas Gelf
dad2aab482 doc/style: fix tab activation 2014-11-20 17:25:58 +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
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
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 Klimov
7ff51caed0 Remove leading backslashes from the targets of use statements
- use \Exception;
+ use Exception;
2014-08-27 15:51:49 +02:00
Eric Lippmann
1dea19504f Revert "Remove leading backslashes from the targets of use statements"
This reverts commit 87a59675011a4cf284d8e44c4fb66042ad84c39f.

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
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
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
788e3eb6fc doc: No longer use separate view scripts
refs #4820
2014-07-28 19:17:03 +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
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
e73471030c doc/modules/index: Only list modules which have the 'doc' directory
refs #4820
2014-06-30 11:43:25 +02:00
Eric Lippmann
61ac3b0168 doc: Fix translation exceptions
refs #6432
refs #4820
2014-06-06 14:45: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
0f1983fb25 doc: Fix links in index view scripts
refs #4820
2014-05-28 17:24:28 +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
2f1303a13b doc: No longer use a partial for viewing a toc
refs #4820
2014-05-28 17:16:37 +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
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
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