Commit Graph

48 Commits

Author SHA1 Message Date
Eric Lippmann 07fb82357b doc: Make documentation for all installed modules avaiable
Before, only documentation of enabled modules was available.

refs #9644
2015-07-27 15:19:32 +02:00
Thomas Gelf 5df2edee09 doc/style/guide: add action table
Problem: CSS in doc module is not "clean" as it has custom styling
2015-06-15 23:31:37 +02:00
Alexander A. Klimov 05b7c3aa6a Replace <h1> w/ <h2>
refs #8847
2015-06-05 16:01:37 +02:00
Alexander A. Klimov 6dedb48444 Indicate that nothing was found in the docs when searching
refs #8847
2015-06-05 15:37:31 +02:00
Johannes Meyer 6b3dd63bb3 Doc module: Fix div.controls of the index controller's index action
refs #7876
2015-04-20 14:55:18 +02:00
Eric Lippmann 8563d5ed3f PHPDoc: Use @var instead of @type
Becasue of too many kittens PSR-5 backed off of deprecating @var.
So that's the way we go too.
2015-03-12 16:08:47 +01:00
Johannes Meyer fb28da8f23 Add proper titles to the documentation module's overview
refs #8458
2015-02-23 17:18:32 +01:00
Johannes Meyer de744fdc83 Add proper title to each module documentation link
refs #8458
2015-02-23 17:17:48 +01:00
Eric Lippmann 8e7faa8170 doc/lib: Use <h1> for search headings
refs #6630
2015-02-11 15:53:41 +01:00
Eric Lippmann 57a0b0005e doc/lib: Fix PDF rendering
refs #6630
2015-02-11 15:15:37 +01:00
Eric Lippmann 6c6c41a4f2 doc/lib: Remove controls from the search view script
Otherwise the dashboard is broken when searching.

refs #6630
2015-02-11 14:05:32 +01:00
Eric Lippmann 3aff91d204 doc/lib: Rename TocRenderer to DocTocRenderer
refs #6630
2015-02-11 14:02:12 +01:00
Eric Lippmann 96ea02e59f doc/lib: Rename SectionRenderer to DocSectionRenderer
refs #6630
2015-02-11 14:01:19 +01:00
Eric Lippmann 16d388f4e3 doc/lib: Use CSS classes controls and content in the view scripts 2015-02-11 13:58:55 +01:00
Eric Lippmann 27c53a315f doc/lib: Add missing search view script
refs #6630
2015-02-11 13:58:22 +01:00
Eric Lippmann f33b6a918c doc/lib: Remove unused view scripts 2015-02-11 13:58:06 +01:00
Eric Lippmann 005ef8c92f doc/lib: Update controllers and views according to the recent changes
refs #6630
2015-02-10 17:09:56 +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
Eric Lippmann 55b3a5384a doc: set page title
refs #4820
2014-08-19 13:38:18 +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 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 e73471030c doc/modules/index: Only list modules which have the 'doc' directory
refs #4820
2014-06-30 11:43:25 +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 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 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 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