Development

Changeset 18445

You must first sign up to be able to contribute.

Changeset 18445

Show
Ignore:
Timestamp:
05/19/09 09:49:47 (4 years ago)
Author:
nicolas.charlot
Message:

fixed README
updated package.xml

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • plugins/isicsBreadcrumbsPlugin/README

    r15203 r18445  
    1 = isicsBreadcrumbsPlugin plugin = 
     1# isicsBreadcrumbsPlugin plugin 
    22 
    33The isicsBreadcrumbsPlugin is a simple way to handle breadcrumbs in your applications. 
    …… 
    55isicsBreadcrumbsPlugin is working on Symfony 1.1 or greater. 
    66 
    7 == At a glance == 
    8  * A singleton who manages breadcrumbsItems. By default, a root item is present (text: Home, uri: @homepage) 
    9  * A component who display the breadcrumbs 
     7## At a glance 
     8  * A singleton who manages breadcrumbsItems. By default, a root item is present (text: Home, uri: @homepage) 
     9  * A component who display the breadcrumbs 
    1010 
    11 == License == 
     11## License 
    1212 
    1313The isicsBreadcrumbsPlugin is licensed under the GNU Lesser General Public License (LGPL). 
    1414 
    15 == Installation == 
     15## Installation 
    1616 
    17  * Install the plugin: 
     17  * Install the plugin: 
     18 
     19        [plain] 
     20        $ symfony plugin:install isicsBreadcrumbsPlugin 
     21        $ symfony cc 
    1822  
    19  {{{ 
    20  $ symfony plugin-install http://plugins.symfony-project.com/isicsBreadcrumbsPlugin 
    21  $ symfony cc 
    22  }}} 
     23  * Enable the module isicsBreadcrumbs in settings.yml: 
    2324  
    24  * Enable the module isicsBreadcrumbs in settings.yml: 
     25        [plain] 
     26        all: 
     27          .settings: 
     28            enabled_modules: [default, isicsBreadcrumbsPlugin] 
    2529  
    26  {{{ 
    27  all: 
    28    .settings: 
    29      enabled_modules:        [default, isicsBreadcrumbsPlugin] 
    30  }}}  
    31   
    32 == Usage == 
     30## Usage 
    3331 
    3432Define the path in your templates: 
    35 {{{ 
    36 #!php 
    37 <?php breadcrumbs->addItem('My action', 'myModule/myAction') ?> 
    3833 
    39   => Home > My action 
    40 }}} 
     34    [php] 
     35    <?php $breadcrumbs->addItem('My action', 'myModule/myAction') ?> 
     36 
     37    => Home > My action 
    4138 
    4239If the action is deeper: 
    43 {{{ 
    44 #!php 
    45 <?php breadcrumbs->addItem('My previous action', 'myModule/myPreviousAction') ?> 
    46 <?php breadcrumbs->addItem('My action', 'myModule/myAction') ?> 
     40 
     41    [php] 
     42    <?php $breadcrumbs->addItem('My previous action', 'myModule/myPreviousAction') ?> 
     43    <?php $breadcrumbs->addItem('My action', 'myModule/myAction') ?> 
    4744   
    48   => Home > My previous action > My action 
    49 }}} 
     45    => Home > My previous action > My action 
    5046 
    5147Define the path in your actions: 
    52 {{{ 
    53 #!php 
    54 public function executeMyAction() 
    55 { 
    56   isicsBreadcrumbs::getInstance()->addItem('My action', 'myModule/myAction'); 
    5748 
    58   => Home > My action 
    59 }}} 
     49    [php] 
     50    public function executeMyAction() 
     51    { 
     52      isicsBreadcrumbs::getInstance()->addItem('My action', 'myModule/myAction'); 
     53 
     54    => Home > My action 
    6055 
    6156Include the breadcrumbs component (in the layout for instance): 
    62 {{{ 
    63 #!php 
    64 <p id="breadcrumbs"> 
    65   You are here : 
    66   <?php include_component('isicsBreadcrumbs', 'show') ?> 
    67 </p> 
    68 }}} 
     57 
     58    [php] 
     59    <p id="breadcrumbs"> 
     60      You are here : 
     61      <?php include_component('isicsBreadcrumbs', 'show') ?> 
     62    </p> 
    6963 
    7064You can set your own root: 
    71 {{{ 
    72 #!php 
    73 <p id="breadcrumbs"> 
    74   You are here : 
    75   <?php include_component('isicsBreadcrumbs', 'show', array( 
    76     'root' => array('text' => 'Home', 'uri' => '@myHomepage'))) ?> 
    77 </p> 
    78 }}} 
    7965 
    80 === API === 
    81  * `void addItem(String $test, String $uri)`: add an item at the end of the breadcrumbs 
    82  * `void clearItems()`: erase all items 
    83  * `isicsBreadcrumbs getInstance()`: retrieve the singleton instance 
    84  * `array getItems()`: return an array of isicsBreadcrumbsItem 
    85  * `void setRoot(String $test, String $uri)`: set root item. By default, a root item is already present (text: Home, uri: @homepage). 
     66    [php] 
     67    <p id="breadcrumbs"> 
     68      You are here : 
     69      <?php include_component('isicsBreadcrumbs', 'show', array( 
     70        'root' => array('text' => 'Home', 'uri' => '@myHomepage') 
     71      )) ?> 
     72    </p> 
     73 
     74## API 
     75  * `void addItem(String $test, String $uri)`: add an item at the end of the breadcrumbs 
     76  * `void clearItems()`: erase all items 
     77  * `isicsBreadcrumbs getInstance()`: retrieve the singleton instance 
     78  * `array getItems()`: return an array of isicsBreadcrumbsItem 
     79  * `void setRoot(String $test, String $uri)`: set root item. By default, a root item is already present (text: Home, uri: @homepage). 
    8680  
    87 == Changelog == 
     81## Changelog 
    8882 
    89 === 2009-02-02 | 0.9.2 beta === 
    90  * Added `breadcrumbs` template shorcut (break compatibility with sf 1.0). 
    91  * Added output escaping support. 
    92  * Removed I18N support (hasn't to be handled here). 
     83### 2009-05-19 | 0.9.4 beta 
     84  * Fixed package.xml 
     85  * Updated README to markdown 
    9386 
    94 === 2008-07-29 | 0.9.1 beta === 
    95  * Added action caching support. 
     87### 2009-02-02 | 0.9.2 beta 
     88  * Added `breadcrumbs` template shorcut (break compatibility with sf 1.0). 
     89  * Added output escaping support. 
     90  * Removed I18N support (hasn't to be handled here). 
     91 
     92### 2008-07-29 | 0.9.1 beta 
     93  * Added action caching support. 
    9694  
    97 === 2008-06-23 | 0.9.0 beta === 
    98  * Initial public release. 
     95### 2008-06-23 | 0.9.0 beta 
     96  * Initial public release. 

  • plugins/isicsBreadcrumbsPlugin/package.xml

    r15203 r18445  
    1111  <active>yes</active> 
    1212 </lead> 
    13  <date>2009-02-02</date> 
     13 <date>2009-05-19</date> 
    1414 <version> 
    15    <release>0.9.3</release> 
    16    <api>0.9.3</api> 
     15   <release>0.9.4</release> 
     16   <api>0.9.4</api> 
    1717 </version> 
    1818 <stability> 
    …… 
    5757    <channel>pear.symfony-project.com</channel> 
    5858    <min>1.1.0</min> 
    59     <max>1.2.0</max> 
     59    <max>1.3.0</max> 
     60    <exclude>1.3.0</exclude 
    6061   </package> 
    6162  </required> 
    …… 
    6667 
    6768 <changelog> 
    68   <release> 
     69  <release>     
    6970   <version> 
    70     <release>0.9.3</release> 
    71     <api>0.9.3</api> 
     71    <release>0.9.4</release> 
     72    <api>0.9.4</api> 
    7273   </version> 
    7374   <stability> 
    …… 
    7576    <api>beta</api> 
    7677   </stability> 
    77    <date>2009-02-02</date> 
     78   <date>2009-05-19</date> 
    7879   <license uri="http://www.gnu.org/licenses/lgpl.html">LGPL</license> 
    7980   <notes> 
    80 Nothing 
     81Fixed package.xml 
     82Updated README to markdown 
    8183   </notes> 
    8284  </release>