Development

Changeset 10391

You must first sign up to be able to contribute.

Changeset 10391

Show
Ignore:
Timestamp:
07/21/08 14:51:50 (5 years ago)
Author:
KRavEN
Message:

Updated readme and wiki
Modified app.yml setting names to be more clear

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • plugins/sfCombineFilterPlugin/branches/kraven/README

    r10389 r10391  
    2121 * Support for script exclusions (mainly for scripts that are incompatible with being packed like tiny_mce) 
    2222 * Automatically replaces relative paths in css files with actual paths 
    23  * Support for css filtered paths for additional paths that need to be removed from the file path before replacing relative paths 
     23 * Support for css filtered paths for additional paths that need to be removed from the file path before replacing relative paths in the css files 
    2424 * Cache that refreshes automatically when source files are changed 
    2525 * Option to minimize the packed.js with JsMinEnh 
    2626 * Option to safe minimize the css 
    27  * Options to only pack/compress the javascript or css in /packed/js or /packed/css 
     27 * Options to only pack the javascript or css in /packed/js or /packed/css 
    2828 * Filter utilizes client side caching to send 403 for unchanged cache files 
    2929 
     
    5454  class:   sfCombineFilter 
    5555    param: 
    56     condition:  <?php echo (in_array('sfCombineFilter',sfConfig::get('sf_enabled_modules')) ? 'true' : 'false')."\n" ? 
     56    condition:  <?php echo (in_array('sfCombineFilter',sfConfig::get('sf_enabled_modules')) ? 'true' : 'false')."\n" ?> 
    5757 
    5858flash:     ~ 
     
    6464add sfCombineFilter to enabled_modules: [] 
    6565 
    66 All settings are made in application/config/app.yml.  See plugins/sfCombineFilterPlugin/config/app.yml for defaults and examples.  You can turn off the filter all together for javascript or css by setting those parameters to "false".  You can turn compression on or off by setting compress_js or compress_css.  You can combine only the files in /packed/js and /packed/css by setting root_js_only and root_css_only to true. 
    67 If you want the combine filter to only be available in the prod environment make a seperate enabled_modules setting for dev: and prod: and leave sfCombineFilter out of dev:. 
     66 * All settings are made in application/config/app.yml.  See plugins/sfCombineFilterPlugin/config/app.yml for defaults and examples. 
     67 * You can turn off the filter all together for javascript or css by setting those parameters to "false".  You can turn pack on or off by setting minimize_js or minimize_css. 
     68 * You can combine only the files in /packed/js and /packed/css by setting root_js_only and root_css_only to true. 
     69 * If you want the combine filter to only be available in the prod environment make a seperate enabled_modules setting for dev: and prod: and leave sfCombineFilter out of dev:. 
    6870 
    6971== Known Issues == 
    7072 
    71 Internet Explorer 6 has problems with large javascript files when gzip compression is on.  If you experience strange issues with your pages in IE6, set compressed: off for you environment in settings.yml and it should resolve the problem 
    72 Requires a memory_limit of 32M or more in php.ini. 
    73 Not really an issue, but the cache/packed_files cache namespace does not get cleared with symfony cc.  This is desirable as the packed files are static data and should only need to be cleared if you are making a lot of changes to the files being packed. 
    74 If you have an issue with your javascript throwing errors only when packed, look for missing semi-colons in your javascript code.  Each code block enclosed within {} should be followed by a semi-colon. 
     73 * Internet Explorer 6 has problems with large javascript files when gzip compression is on.  If you experience strange issues with your pages in IE6, set compressed: off for you environment in settings.yml and it should resolve the problem 
     74 * Requires a memory_limit of 32M or more in php.ini. 
     75 * Not really an issue, but the cache/packed_files cache namespace does not get cleared with symfony cc.  This is desirable as the packed files are static data and should only need to be cleared if you are making a lot of changes to the files being packed. 
     76 * If you have an issue with your javascript throwing errors only when minimized, look for missing semi-colons in your javascript code.  Each code block enclosed within {} should be followed by a semi-colon. 
     77 * There may be some issues with script include order if you have .pjs, .pcss files, or script exclusions.  It's generally best to ensure that packed.js is included before anything else. 
    7578 
    7679== Changelog == 
     
    8790 - New: Option to minify the js using JSMin. 
    8891 
    89  === 2008-07-18 | 0.1.2 beta === 
     92 === 2008-07-21 | 0.1.2 beta === 
    9093Changes by Benjamin Runnels: 
    9194 - Moved cache generation/management into the filter 
    9295 - Removed .htaccess modification requirements 
    93  - added compress_js and compress_css options to the filter 
     96 - added minimize_js and minimize_css options to the filter 
    9497 - added client side caching for the packed files and improved the request name so it will cache properly 
    9598 - added routing rules to route to the sfCombineFilter module 
    96  - added non-harmfull css compresso
     99 - added non-harmfull css minimize
    97100 - added path replacement in css files to resolve relative path issues 
    98  - switched to JsMinEnh class to improve memory usage and speed of javascript compression 
     101 - switched to JsMinEnh class to improve memory usage and speed of javascript minimizing 
  • plugins/sfCombineFilterPlugin/branches/kraven/config/app.yml

    r10174 r10391  
    11all: # these are the defaults, you should override them in your application/config/app.yml file 
    22  sf_combine_filter_plugin: 
    3     css_filtered_paths:          [%SF_ROOT_DIR%, plugins/, web/]  # you probably want to end your paths (comma seperated) with a / 
     3    css_filtered_paths:          [%SF_ROOT_DIR%, plugins/, web/]  # you want to end your paths (comma seperated) with a / 
    44    js_exclude_files:            [tiny_mce]   # you probably want E.G. tiny_mce in here, so I did this for you ;-) 
    55 
     
    77    #javascripts:    true 
    88    #stylesheets:    true 
    9     #compress_js:    false 
    10     #compress_css:   true 
     9    #minimize_js:    false 
     10    #minimize_css:   true 
    1111    #root_js_only:   false 
    1212    #root_css_only:  false