Changes between Version 3 and Version 4 of AddHeadersPlugin

Timestamp:

Nov 1, 2008, 2:18:35 PM (15 years ago)

Author:

Martin Scharrer

Comment:

Added more examples.

AddHeadersPlugin

@@ -43 +43 @@
 
 
-See also the [#Example example] below.
+See also the [#Examples example] below.
 
 == Bugs/Feature Requests == 
@@ -59 +59 @@
 == Source ==
 
-You can check out AddHeadersPlugin from [http://trac-hacks.org/svn/addheadersplugin here] using Subversion, or [source:addheadersplugin browse the source] with Trac.
+You can check out AddHeadersPlugin from [http://trac-hacks.org/svn/addheadersplugin/0.11 here] using Subversion, or [source:addheadersplugin/0.11 browse the source] with Trac.
 
-== Example ==
-The following example shows how to add files for a multi-style implementation:
+== Examples ==
+=== Multi-Style ===
+The following example shows how to add files for a multi-style implementation, i.e. the user can select between different graphics styles:
 The !JavaScript file is located at `$TRAC_PROJECT_DIR/htdocs/js/multistyle.js` and all CSS files are located at `$TRAC_PROJECT_DIR/htdocs/css/`.
 A general style file '`common.css`' is included which holds all common style definition. The default style is in '`default.css`' and the alternative styles in '`theme1.css`' and '`theme2.css`'.
@@ -93 +94 @@
 }}}
 
+=== Adding custom !JavaScript and CSS ===
+The following example shows how to add some custom !JavaScript and CSS files. Here they all start with a common prefix. The JS files (abc_one.js,abc_two.js,abc_tree.js) are positioned in the `$TRAC_PROJECT_DIR/htdocs/js/` and the CSS files (style_print.css,style_screen.css) `$TRAC_PROJECT_DIR/htdocs/css/` directory.
+
+{{{
+# in trac.ini
+[addheaders]
+default_style_base  = site/css/
+default_script_base = site/js/
+
+add_scripts  = abc_one,abc_two,abc_tree
+add_styles   = style_print,style_screen
+}}}
+
+or, even shorter:
+
+{{{
+# in trac.ini
+[addheaders]
+default_style_base  = site/css/abc_
+default_script_base = site/js/style_
+
+add_scripts  = one,two,tree
+add_styles   = print,screen
+}}}
+
+=== Weird filenames ===
+While the names given by `add_scripts` or `add_styles` is used to build the default filename, it becomes just an arbitrary string when the real filename is set explicitly using ''<name>''`.filename`.
+This can be used when the real filename is quit weird, e.g. has commas included or is very long. Make sure to use an UTF-8 capable editor when adding non-ASCII letters.
+{{{
+# in trac.ini
+[addheaders]
+
+add_scripts  = short
+
+short.filename = /site/somewhere/Very,weird,filename @;'öäßÖÄß¼€.js
+# Also possible to change the MIME-type (default is 'text/javascript')
+short.type     = text/something
+
+# Same for style files
+# General link files must always be set explicitly
+}}}
+
 
 == Recent Changes ==