Commit Graph

281 Commits

Author SHA1 Message Date
Eric Lippmann 7ea559e6be doc: Namespace the IcingawebController
refs #5786
2015-08-27 14:40:10 +02:00
Eric Lippmann 2f1d6d7a95 doc: Add PHPDoc to IndexController 2015-08-27 14:40:10 +02:00
Eric Lippmann 77b9881a38 doc: Namespace IndexController
refs #5786
2015-08-27 14:40:02 +02:00
Eric Lippmann 26c403832e doc: Namespace the ModuleController
refs #5786
2015-08-27 14:36:26 +02:00
Eric Lippmann 66e50ad341 doc: Remove unused alias in the ModuleController
Thanks for not reviewing commits!
2015-08-27 14:35:26 +02:00
Eric Lippmann ad389d1696 doc: Fix PHPDoc of SearchController::getWebPath() 2015-08-27 14:24:25 +02:00
Eric Lippmann f0f24bee94 doc: Namespace the SearchController
refs #5786
2015-08-27 14:23:35 +02:00
Eric Lippmann 8981f2cc26 doc: Optimize imports in the SearchController 2015-08-27 14:22:59 +02:00
Eric Lippmann 5fadb647e2 doc: Namespace the StyleController
refs #5786
2015-08-27 14:22:35 +02:00
Eric Lippmann f1a63a36f5 doc: Support header-less sections 2015-08-11 09:20:56 +02:00
Eric Lippmann 82d36e11cc doc: Replace whitespaces with - for section IDs
Fixes jQuery selector issues when jumping to an anchor.
2015-08-11 09:20:56 +02:00
Eric Lippmann 4e3fbb1341 doc: Support setext-style only headers
Setext-style used to work before too but only if an atx-style header comes first.
2015-08-11 09:20:56 +02:00
Matthias Jentsch f8e2dc850c Drop IniEditor and clean up IniWriter
Replace the ini editor code with a new parser implementation that manipulates a DOM. Do not support capabillities that are no longer needed, like nested configurations, section inheritance, section-less properties.
2015-08-05 18:10:17 +02:00
Eric Lippmann 5ae21fd196 doc: Set parameters from route explicitly
refs #9817
2015-08-04 12:48:53 +02:00
Eric Lippmann 5c5dea616d doc: Use Params::getRequired() in ModuleController
refs #9644
2015-07-28 13:59:59 +02:00
Eric Lippmann 794e4a1e1e doc: Use Params::getRequired() in IcingawebController
refs #9644
2015-07-28 13:59:39 +02:00
Eric Lippmann 9a758f3ed9 doc: Use Controller::httpNotFound() in SearchController
refs #9644
2015-07-28 13:47:25 +02:00
Eric Lippmann 9846dfb2e2 doc: Use Controller:httpNotFound() in ModuleController
refs #9644
2015-07-28 13:47:06 +02:00
Eric Lippmann 7cfc78558d Merge branch 'master' into feature/secure-modules-9644
Conflicts:
	library/Icinga/Exception/IcingaException.php
2015-07-28 13:42:02 +02:00
Eric Lippmann d850cffa42 doc: Remove unnecessary use in SearchController
refs #9449
2015-07-28 11:55:27 +02:00
Eric Lippmann b3f463a7a5 doc: Remove unnecessary use in ModuleController
refs #9449
2015-07-28 11:54:55 +02:00
Eric Lippmann e70fb76d31 doc: Remove unnecessary use in IcingawebController
refs #9449
2015-07-28 11:54:00 +02:00
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 3462f0ee9a Merge remote-tracking branch 'origin/master' into feature/refine-ui-for-rc1-9361
Conflicts:
	modules/monitoring/application/views/scripts/host/history.phtml
	modules/monitoring/application/views/scripts/list/services.phtml
2015-06-18 11:26:51 +02:00
Matthias Jentsch f31f18dc51 Move security documentation for monitoring module into correct directory
refs #9377
2015-06-16 17:54:21 +02:00
Matthias Jentsch 5b8c308679 Merge branch 'bugfix/use-statement-error-9281'
fixes #9281
2015-06-16 17:06:47 +02:00
Matthias Jentsch 5bf7bbdb8b Remove unneeded use statements from global namespaces
Use statements on global classes from the global namespace don't have any effect, prevent warnings from being displayed in php versions >= 5.6.9 and version >= 5.5.25.

refs #9281
2015-06-16 16:10:52 +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
Matthias Jentsch ea85254cc5 Fix typos and formatting in documentation
refs #9377
2015-06-15 11:09:41 +02:00
Matthias Jentsch 3eb4561f79 Merge branch 'feature/permission-restriction-documentation-9377'
fixes #9377
2015-06-10 19:04:47 +02:00
Matthias Jentsch edd1c2a1f3 Move monitoring permission documentation into a separate module
refs #9377
2015-06-10 18:43:54 +02:00
Alexander A. Klimov 6e045b6239 Change version in modules/*/module.info to 2.0.0-rc1
refs #7651
2015-06-08 13:19:46 +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 7b9983de38 Merge the menu entries for users, groups and roles into "Authentication" 2015-06-01 17:16:24 +02:00
Johannes Meyer c7ce1498bf Introduce menu entry "Configuration" 2015-06-01 16:10:23 +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
Alexander A. Klimov 20b09d3bda Inherit from Icinga\Web\Controller rather than from Icinga\Web\Controller\ModuleActionController 2015-04-08 15:13:59 +02:00
Thomas Gelf 697d4aff27 doc/search: do not break on "ill-formed" docs
We got ugly exceptions for non-obvious errors such as missing titles
2015-03-13 08:57:45 +01:00
Thomas Gelf 6bf8849d98 doc/search: do not search with less than 3 chars
Please consider this a quickfix to avoid mass results while typing in
the global search field. We need farther improvements here:
* compact mode: e.g. title/first match on one row
* show a hint when less than 3 chars have been provided
* allow two chars once we fixed the above
2015-03-13 08:57:45 +01:00
Eric Lippmann 3970d7dec2 Lower doc modules search priority
refs #8668
2015-03-12 18:09:43 +01: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
Louis Sautier 083c1a9e6b Fix some spelling errors in comments and messages
fixes #8633

Signed-off-by: Gunnar Beutner <gunnar@beutner.name>
2015-03-08 15:32:22 +01:00
Johannes Meyer f2259557c8 Fix missing tab labels
fixes #8518
2015-02-27 09:32:44 +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
Johannes Meyer 49e7964355 Use an already existing variable instead of calling a function twice.. 2015-02-23 17:13:55 +01:00
Johannes Meyer a1e7cd8906 Add proper titles to the documentation tocs and search results
refs #8458
2015-02-23 17:12:34 +01:00
Eric Lippmann f00f598014 doc/lib: Fix undefined entity &nbsp and too greedy regex 2015-02-12 10:24:55 +01:00
Eric Lippmann 8e7faa8170 doc/lib: Use <h1> for search headings
refs #6630
2015-02-11 15:53:41 +01:00
Eric Lippmann fdec27d8a1 doc/lib: Remove DocSearchIterator::count()
refs #6630
2015-02-11 15:53:23 +01:00
Eric Lippmann 53af279ec2 doc/lib: Fix search criteria not splitting "complex" search strings correctly
refs #6630
2015-02-11 15:52:08 +01:00
Eric Lippmann 310201eb5b doc/lib: Throw LogicException if text is added without having a heading 2015-02-11 15:51:31 +01:00
Eric Lippmann 57a0b0005e doc/lib: Fix PDF rendering
refs #6630
2015-02-11 15:15:37 +01:00
Eric Lippmann 03100b8c59 doc/lib: Move all renderer classes to the renderer namespace
refs #6630
2015-02-11 14:10:12 +01:00
Eric Lippmann d1aed4f773 doc/lib: Rename SectionFilterIterator to DocSectionFilterIterator
refs #6630
2015-02-11 14:06:41 +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 924e67f2aa doc/lib: Rename Renderer to DocRenderer
refs #6630
2015-02-11 14:05:18 +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 e26154e88a doc/lib: Remove unused less mixins 2015-02-11 13:58:39 +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 195aa581cb doc/lib: Fix that highlighting a search messes up the text around the match
refs #6630
2015-02-11 13:48:23 +01:00
Eric Lippmann 6f1fdad9c2 doc/lib: Add CSS for highlighting search results
refs #6630
2015-02-11 13:27:04 +01:00
Eric Lippmann fa37f84cac doc/lib: Search in module documentations too
refs #6630
2015-02-11 13:22:27 +01:00
Eric Lippmann 4931418c03 doc/lib: Pass highlight-search parameter to the renderer
refs #6630
2015-02-11 13:21:01 +01:00
Eric Lippmann 57ca11cb76 doc/lib: Highlight search when displaying a chapter
refs #6630
2015-02-11 13:20:30 +01:00
Eric Lippmann 512eb3fe83 doc/lib: Remove DocSearchRenderer::highlight()
refs #6630
2015-02-11 13:16:55 +01:00
Eric Lippmann ab78757483 doc/lib: Add DocSearchMatch::highlight()
refs #6630
2015-02-11 13:16:49 +01:00
Eric Lippmann 1053e62e20 doc/lib: Fix DocSearchIterator::count() counting too many
Because DocSearchIterator is a recursive filter iterator and we accept
any hode having children, those children not matching any of the search criteria
were counted too because of iterator_count.

refs #6630
2015-02-11 13:03:46 +01:00
Eric Lippmann 21b65d8079 doc/lib: Show trace in case an exception is thrown during rendering
refs #6630
2015-02-11 13:03:01 +01:00
Eric Lippmann d2520f1286 doc/lib: Prefer @type over @var in the DocParser
refs #6630
2015-02-11 13:02:33 +01:00
Eric Lippmann bd71dbdbdc doc/lib: Rearrange imports in the DocIterator
refs #6630
2015-02-11 13:02:04 +01:00
Eric Lippmann 0b1a9c1659 doc/lib: Apply role and css class toc to the toc
refs #6630
2015-02-11 12:58:31 +01:00
Eric Lippmann e2b34023cd doc/lib: Add SearchController
At the moment only Icinga Web 2's documentation is available for searching.

refs #6630
2015-02-10 17:14:16 +01:00
Eric Lippmann 3b20e49940 doc/lib: Add renderer for doc searches
refs #6630
2015-02-10 17:13:17 +01:00
Eric Lippmann e7b0f8d30f doc/lib: Add iterator over doc sections that match a given search criteria
refs #6630
2015-02-10 17:12:43 +01:00
Eric Lippmann 267c36d8d1 doc/lib: Add class DocSearchMatch represeting a search match
refs #6630
2015-02-10 17:11:48 +01:00
Eric Lippmann 312d18d14a doc/lib: Add DocSearch class for creating search criteria
refs #6630
2015-02-10 17:11:00 +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
Eric Lippmann 41355fe0e2 doc/lib: Drop navigation added to each section
refs #6630
2015-02-10 17:08:48 +01:00
Eric Lippmann 5965638e23 doc/lib: Open toc links in the next container
refs #6630
2015-02-10 17:07:24 +01:00
Eric Lippmann 52de56fb65 doc/lib: Use TreeNodeIterator in the SectionFilterIterator
refs #6630
2015-02-10 17:06:11 +01:00
Eric Lippmann 9093795f64 doc/lib: Add common used methods to the abstract Renderer
refs #6630
2015-02-10 17:05:24 +01:00
Eric Lippmann 377685d802 doc/lib: Let DocException extend IcingaException 2015-02-10 17:04:46 +01:00
Eric Lippmann c95838a33d doc/lib: Use SimpleTree in the DocParser
refs #6630
2015-02-10 17:04:27 +01:00
Eric Lippmann 9f3b953165 doc/lib: Support setting the chapter a section belongs to
refs #6630
2015-02-10 17:03:58 +01:00
Eric Lippmann 07cfbe23ef doc/lib: Use @inheritdoc in the DocIterator 2015-02-10 17:03:15 +01:00
Eric Lippmann b2ace4e209 doc: Remove DocTree class
It will be replaced by a class in our lib

refs #6630
2015-02-10 16:58:40 +01:00
Eric Lippmann ecfda1a6f5 lib/doc: Rename Section to DocSection and let it extend TreeNode
refs #6630
2015-02-06 17:29:04 +01:00
Eric Lippmann 95c937e3fd lib/doc: Fix code style for doc exceptions 2015-02-06 17:24:01 +01:00
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