WordPress.org

Plugin Directory

Changeset 622104


Ignore:
Timestamp:
11/07/12 12:57:11 (18 months ago)
Author:
tar.gz
Message:

improved README

File:
1 edited

Legend:

Unmodified
Added
Removed
  • minimalistic-event-manager/trunk/readme.txt

    r621864 r622104  
    11=== Minimalistic Event Manager === 
    22Contributors: de-ce, tar.gz 
    3 Donate link: https://flattr.com/thing/972318/ms-studio/minimalistic-event-manager-on-GitHub 
     3Donate link: https://flattr.com/thing/972318/ 
    44Tags: dates, events, time 
    55Requires at least: 3.4 
     
    1313== Description == 
    1414 
    15 This plugin (MEM or Minimalistic Event Manager) is intended for theme authors and developers, who want a simple, robust and flexible solution for managing event dates.  
     15This plugin (MEM or Minimalistic Event Manager) is intended for theme authors and developers who want a simple, robust and flexible solution for managing event dates.  
    1616 
    17 The MEM plugin offers a clean interface that allows to add event dates (start dates, end dates, repeating dates) to posts (and to any custom post type). 
     17The MEM plugin offers a clean interface that allows to add _event dates_ (start dates, end dates, repeating dates) to _posts_ (and to any custom post type). 
    1818 
    1919= The main features = 
    2020 
    21 * Dates can be attached to any post type: Posts, Pages, Custom Post Types... (optionally, they can be restricted to specific content types). 
    22 * Dates can be of three types: start dates, end dates, repeating dates. 
    23 * There is no mandatory date format: Time, Day, and Month are optional. An event date could be "January 2046", or just "2046". 
     21- Event dates can be attached to any post type: Posts, Pages, Custom Post Types... (optionally, they can be restricted to specific content types). 
     22- Event dates can be of three types: start dates, end dates, repeating dates. 
     23- There is no mandatory date format: Time, Day, and Month are optional. An event date could be "January 2046", or just "2046". 
    2424 
    25 = What the plugin doesn’t do = 
     25= What the plugin _doesn’t_ do = 
    2626 
    27 The MEM plugin works as a simple interface for entering those dates into custom fields, but it won’t do anything on the public side of your theme. What happens with the dates on the frontend is entirely up to you! You must decide how to display the dates, and you will have to edit your theme files for that… 
     27The MEM plugin works as a simple interface for entering those dates into custom fields, but it won’t do anything on the public side of your theme. What happens with the dates on the front-end is entirely up to you! You must decide how to display the dates, and you will have to edit your theme files for that… 
    2828 
    29 If you aren’t sure how to achieve this, our [wiki](https://github.com/ms-studio/minimalistic-event-manager/wiki) will provide a collection of examples to get you started. 
     29If you aren’t sure how to achieve this, [our wiki](https://github.com/ms-studio/minimalistic-event-manager/wiki) will provide a collection of examples to get you started. 
    3030 
    3131= Technical implementation = 
     
    3333Technically, the MEM plugin stores the dates as ordinary Custom Fields, in a _machine-readable_ format (such as "2012-11-23 13:37"). This gives you absolute freedom for displaying your events in your theme: 
    3434 
    35 * You can query for specific date ranges by using the meta_key / meta_compare parameters. 
    36 * You can use the php `date` function to display the date in any possible manner (or `date_i18n` for proper localization). 
     35- You can query for specific date ranges by using the meta_key / meta_compare parameters. 
     36- You can use the php `date` function to display the date in any possible manner (or `date_i18n` for proper localization). 
    3737 
    3838= Plugin options = 
     
    4040The plugin has two settings that can be modified with a few lines in your `functions.php` file: 
    4141 
    42 * You can limit it to specific post types. 
    43 * You can use an "alpha" mode, which gives you a blank input field for each date. This can be useful if you need to enter dates that don’t fit the predefined format. 
     42- You can limit it to specific post types. 
     43- You can use an "alpha" mode, which gives you a blank input field for each date. This can be useful if you need to enter dates that don’t fit the predefined format. 
    4444 
    4545See the online documentation for the full instructions. 
     
    5151= Credits = 
    5252 
    53 * **Concept and maintenance** [ms-studio.net](http://ms-studio.net) 
    54 * **Development**: [Dream Production](http://dreamproduction.net/) 
     53- **Concept and maintenance** [ms-studio.net](http://ms-studio.net) 
     54- **Development**: [Dream Production](http://dreamproduction.net/) 
    5555 
    5656== Installation == 
Note: See TracChangeset for help on using the changeset viewer.