WordPress.org
Get WordPress

Plugin Directory

Changeset 166031


Ignore:
Timestamp:
10/22/2009 10:55:48 PM (16 years ago)
Author:
johanee
Message:

Updated readme.txt for 1.1

File:
1 edited

Legend:

Unmodified
Added
Removed

  • cache-translation-object/trunk/readme.txt

    r165890 r166031  
    66Stable tag: 1.0
    77
    8 Substantially increase performance of localized WordPress by caching the translation (l10n) object between pageloads.
     8Substantially increase performance of localized WordPress by caching the translation (l10n) object. Supports multiple languages.
    99
    1010== Description ==
    1111
    12 On every pageload a localized WordPress blog spends a huge amount of time setting up the translation (l10n) object. Compared to an un-translated site the startup can take up to four times longer.
     12On every pageload a localized WordPress site spends a huge amount of time setting up the translation (l10n) object. Startup for a localized site can be almost four times slower than an untranslated one.
    1313
    14 This plugin stores the translation (l10n) object between pageloads resulting in significantly better performance.
     14This plugin stores the translation object between pageloads so it only has to be created once, resulting in significantly better performance (performance graph included with screenshot).
    1515
    16 Available storage: As a file, APC (Alternative PHP Cache), or SHMOP (Shared Memory)
     16Plugin supports caching multiple languages (if you use a multi-language plugin).
     17
     18Available storage: Plain file, APC (Alternative PHP Cache), or SHMOP (Shared Memory)
    1719
    1820== Installation ==
    … …  
    21232. Activate the plugin through the WordPress admin interface.
    22243. Select an available storage on options page (see FAQ for more details if necessary).
    23 3a. If storing as a file make sure we can write to it.
    24 4. If you run multiple WordPress sites on the same host please consult the plugin homepage for more information.
     254. File storage needs write permissions (once) to wp-content after install to set up the directory used for storage (`wp-content/cache/l10n-cache`). Once set up is finished wp-content should be kept write protected.
     265. If you run multiple WordPress sites on the same host please consult the plugin homepage for more information.
    2527
    2628If you have any questions or problems go to: http://devel.kostdoktorn.se/cache-translation-object
    … …  
    2830== Frequently Asked Questions ==
    2931
    30 = What storage is fastest? =
     32= Which storage is better / faster? =
    3133
    32 The exact numbers will depend on your configuration but in my testing APC is a tiny bit faster than shared memory which is a bit faster than plain file storage. Check out the plugin homepage for some graphs.
     34The exact performance will depend on your configuration but in my testing APC is a tiny bit faster than shared memory which is a bit faster than plain file storage. Check out the plugin homepage for some graphs.
    3335
    3436= What is APC (Alternative PHP Cache)? =
    … …  
    3638"The Alternative PHP Cache (APC) is a free and open opcode cache for PHP. Its goal is to provide a free, open, and robust framework for caching and optimizing PHP intermediate code."
    3739
    38 It is not usually installed with PHP by default.
     40It is not usually installed by default.
    3941
    4042= What is SHMOP (Shared Memory)? =
    4143
    42 It is a PHP interface to handle Unix shared memory segments. It should be available by default on Linux/Unix servers. On Windows it may be possible to enable in PHP.ini.
     44SHMOP is a PHP interface to handle Unix shared memory segments. It should be available by default on Linux/Unix servers. On Windows it may be possible to enable in PHP.ini.
    4345
    44 = How do I make the file writable? =
     46On some older systems (and Windows) shared memory may have problems when multiple languages are cached. (If `Open slots` in the debug storage information keeps decreasing you should choose a different storage type.)
     47
     48= How do I make files writable? =
    4549
    4650`http://codex.wordpress.org/Changing_File_Permissions`
    4751
    48 The file must be writable by the webserver when using file storage.
     52File storage write files to `wp-config/cache/l10n-cache/`. These directories will be created automatically if `wp-config` is writable at first use. Once these sub-directories are created `wp-config` should be kept write protected.
    4953
    50 = I want to change where the file is written =
     54= I want to change where the files are stored =
    5155
    52 Currently you'll have to do it by hand. Find the define at the top of wp-content/plugin/cache-translation-object/cache-translation-object-file.php
     56Currently you'll have to do it by hand. Find it at the top of wp-content/plugin/cache-translation-object/cache-translation-object-file.php
    5357
    5458== Screenshots ==
    … …  
    6064
    6165= Version 1.1 =
    62 * Handle multiple locales
    63 * Split out admin functions in separate file
     66* Rewritten to cache multiple locales separately
     67* Split out admin functions into separate file
     68* Handle old SHM with questionable delete behaviour by relocating as necessary.
     69* Add storage debug info link
    6470* Do not default to any specific storage type, make user choose
    65 * Tell admin when something is wrong!
     71* Tell admin when something is wrong (also better error handling).
    6672* Added plugin localization
    6773* Added Swedish translation
Note: See TracChangeset for help on using the changeset viewer.