Commit Graph

96 Commits

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