Changes between Version 2 and Version 3 of AddHeadersPlugin


Ignore:
Timestamp:
Nov 1, 2008, 12:31:20 AM (12 years ago)
Author:
Martin Scharrer
Comment:

Added usage information.

Legend:

Unmodified
Added
Removed
Modified
  • AddHeadersPlugin

    v2 v3  
    1515
    1616== Usage ==
    17 Comming soon. In the meantime see the [#Example example] below.
     17The plugin is controlled over settings the Trac config file (normally '`conf/trac.ini`').
     18All settings must be put in the section `[addheaders]`.
     19
     20=== Settings ===
     21 `default_base = `''<path relative to base URL>'' (default: '`site/`'):: This is used as default base of the files relative to the base URL (which is e.g. `http://trac.example.org/project1/`). Please note that URL paths not local file paths are used. The default is `site/` which is the relative URL for the `htdocs` directory in your `$TRAC_PROJECT_DIR`.
     22
     23 `default_script_base = `''<path relative to base URL>'' (default: `default_base`):: To provide an different default path for scripts.
     24
     25 `default_style_base = `''<path relative to base URL>'' (default: `default_base`):: To provide an different default path for style files.
     26
     27 `add_scripts = `''<name1>''`,`''<name2>''`,``...`:: Will add `script` tags for all given names. The mime-type and filename can be defined by:
     28   * ''<name>''`.type = `''<MIME-type>'' (default: '`text/javascript`')
     29   * ''<name>''`.filename = `''<filename incl. path>'' (default: `default_script_base`''<name>''`.js`)
     30
     31 `add_styles = `''<name1>''`,`''<name2>''`,``...`:: Will add CSS `link` tags for all given names. The mime-type and filename can be defined by:
     32   * ''<name>''`.type = `''<MIME-type>'' (default: '`text/css`')
     33   * ''<name>''`.filename = `''<filename incl. path>'' (default: `default_style_base`''<name>''`.css`)
     34
     35 `add_link = `''<name1>''`,`''<name2>''`,``...`:: Will add general `link` tags for all given names. There exists no default setting.[[BR]]
     36  [[BR]]The following settings are mandatory:
     37   * ''<name>''`.rel = `''<Relation of the link>''
     38   * ''<name>''`.href = `''<Relative URL of the link>''
     39  [[BR]]The following settings are obtional:
     40   * ''<name>''`.title = `''<Link title>''
     41   * ''<name>''`.type = `''<MIME-type of linked content>''
     42   * ''<name>''`.class = `''<(CSS?) class of link>''
     43
     44
     45See also the [#Example example] below.
    1846
    1947== Bugs/Feature Requests ==