From 1dda9ae45fbe02bfcc0d07390ec757142ebf5370 Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Fri, 5 Apr 2013 15:34:29 +0200 Subject: [PATCH] Fixed extra_requirements docs --- admin/code/LeftAndMain.php | 15 +++++++++++++++ docs/en/howto/extend-cms-interface.md | 7 ++++++- docs/en/reference/preview.md | 2 +- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/admin/code/LeftAndMain.php b/admin/code/LeftAndMain.php index b1c47f26f..3cca23b1b 100644 --- a/admin/code/LeftAndMain.php +++ b/admin/code/LeftAndMain.php @@ -120,12 +120,27 @@ class LeftAndMain extends Controller implements PermissionProvider { * Used mainly to work around the missing "lazy loading" functionality * for getting css/javascript required after an ajax-call (e.g. loading the editform). * + * YAML configuration example: + * + * LeftAndMain: + * extra_requirements_javascript: + * mysite/javascript/myscript.js: + * + * * @config * @var array */ private static $extra_requirements_javascript = array(); /** + * YAML configuration example: + * + * LeftAndMain: + * extra_requirements_css: + * mysite/css/mystyle.css: + * media: screen + * + * * @config * @var array See {@link extra_requirements_javascript} */ diff --git a/docs/en/howto/extend-cms-interface.md b/docs/en/howto/extend-cms-interface.md index 58a0ef4bd..f931e8f4a 100644 --- a/docs/en/howto/extend-cms-interface.md +++ b/docs/en/howto/extend-cms-interface.md @@ -62,7 +62,12 @@ Paste the following content into a new file called `mysite/css/BookmarkedPages.c .cms-bottom-bar a {color: #444444;} Load the new CSS file into the CMS, by setting the `LeftAndMain.extra_requirements_css` -[configuration value](/topics/configuration) to 'mysite/css/BookmarkedPages.css'. +[configuration value](/topics/configuration). + + :::yml + LeftAndMain: + extra_requirements_css: + mysite/css/BookmarkedPages.css: ## Create a "bookmark" flag on pages ## diff --git a/docs/en/reference/preview.md b/docs/en/reference/preview.md index eed5ae0f3..fde31481d 100644 --- a/docs/en/reference/preview.md +++ b/docs/en/reference/preview.md @@ -69,7 +69,7 @@ to the `LeftAndMain.extra_requirements_javascript` [configuration value](/topics :::yml LeftAndMain extra_requirements_javascript: - - 'mysite/javascript/MyLeftAndMain.Preview.js' + mysite/javascript/MyLeftAndMain.Preview.js: In order to find out which configuration values are available, the source code is your best reference at the moment - have a look in `framework/admin/javascript/LeftAndMain.Preview.js`.