add documentation on how to add stylesheets and javascript files

This commit is contained in:
Bernhard Posselt
2013-09-06 15:48:22 +02:00
parent 829effbb57
commit 4cee3cf1cb
2 changed files with 7 additions and 0 deletions

View File

@@ -3,6 +3,8 @@ CSS
.. sectionauthor:: Bernhard Posselt <nukeawhale@gmail.com>
Stylesheets have to be included in your templates, see :doc:`static`
If you have to include an image or css file in your CSS, prepend the following to your path:
* **%appswebroot%**: gets the absolute path to your app

View File

@@ -9,5 +9,10 @@ Static content consists of:
* **js/**: all JavaScript files
* **css/**: all CSS files
Because ownCloud templates do not support template inheritance it is not possible to add your own script tags. Therefore ownCloud provides the methods **\\OCP\Util::addScript('your_app_id', 'script')** and **\\OCP\Util::addStyle('your_app_id', 'style')**. The first parameter is the app's id, the second one is the path relative to the **js/** respectively the **css/** folder without the file extension.
If you use Twig Templates, there is the **script** and **style** function, see :doc:`../appframework/templates`.
CSS and JavaScript are compressed by ownCloud so if the CSS or JavaScript do not seem to get updated, check if the debug mode is enabled. To enable it see :doc:`../intro/gettingstarted`