Bläddra i källkod

[docs] updated documentation

gediminasm 13 år sedan
förälder
incheckning
8b4ceed379
2 ändrade filer med 7 tillägg och 12 borttagningar
  1. 4 11
      README.md
  2. 3 1
      doc/sluggable.md

+ 4 - 11
README.md

@@ -1,5 +1,7 @@
 # Doctrine2 behavioral extensions
 # Doctrine2 behavioral extensions
 
 
+**Version 2.2-DEV**
+
 This package contains extensions for Doctrine2 that hook into the facilities of Doctrine and
 This package contains extensions for Doctrine2 that hook into the facilities of Doctrine and
 offer new functionality or tools to use Doctrine2 more efficently. This package contains mostly
 offer new functionality or tools to use Doctrine2 more efficently. This package contains mostly
 used behaviors which can be easily attached to your event system of Doctrine2 and handle the
 used behaviors which can be easily attached to your event system of Doctrine2 and handle the
@@ -18,9 +20,6 @@ can be easily implemented using Mapping extension to handle the additional metad
 **Note:** doctrine2.0.x branch is no longer being supported and all new features
 **Note:** doctrine2.0.x branch is no longer being supported and all new features
 and fixes are on master branch, which currently supports 2.1.x versions of doctrine2
 and fixes are on master branch, which currently supports 2.1.x versions of doctrine2
 
 
-**Note:** from now on there is only one listener per extension which supports ODM and ORM adapters to deal with objects. Only one instance of listener is 
-required, and can be attached to many different type object managers, currently supported (ORM or ODM)
-
 **Note:** Please note, that xml mapping needs to be in a different namespace, the declared namespace for
 **Note:** Please note, that xml mapping needs to be in a different namespace, the declared namespace for
 Doctrine extensions is http://gediminasm.org/schemas/orm/doctrine-extensions-mapping
 Doctrine extensions is http://gediminasm.org/schemas/orm/doctrine-extensions-mapping
 So root node now looks like this:
 So root node now looks like this:
@@ -37,7 +36,7 @@ master branch is based on 2.2.x versions and may not work with 2.1.x
 
 
 ### Latest updates
 ### Latest updates
 
 
-**2011-09-11**
+**2011-09-23**
 
 
 - Refactored sluggable for doctrine2.2 by specifieng slug fields directly in slug annotation
 - Refactored sluggable for doctrine2.2 by specifieng slug fields directly in slug annotation
 - Slug handler functionality, possibility to create custom ones or use built-in
 - Slug handler functionality, possibility to create custom ones or use built-in
@@ -49,13 +48,6 @@ By default there is TreeSlug, RelativeSlug handlers. Which can build a tree path
 example: **category/shoes/nike**. Using relative slug handler it is possible to have related slug
 example: **category/shoes/nike**. Using relative slug handler it is possible to have related slug
 for example, user is related to company by ManyToOne relation in result slug is: **company/user-name**
 for example, user is related to company by ManyToOne relation in result slug is: **company/user-name**
 
 
-**2011-07-14**
-
-- Sluggable can handle multiple slug fields, now on Sluggable annotation you will need
-to provide slugField property it should belong to
-- Translatable query hint will use **default locale** translations in case if it does not
-have a translation in currently used locale
-
 ### ODM MongoDB support
 ### ODM MongoDB support
 
 
 List of extensions which support ODM
 List of extensions which support ODM
@@ -88,6 +80,7 @@ To setup and run tests follow these steps:
 
 
 ### Contributors:
 ### Contributors:
 
 
+- Lukas Botsch [lbotsch](http://github.com/lbotsch)
 - Daniel Gomes [danielcsgomes](http://github.com/danielcsgomes)
 - Daniel Gomes [danielcsgomes](http://github.com/danielcsgomes)
 - megabite [oscarballadares](http://github.com/oscarballadares)
 - megabite [oscarballadares](http://github.com/oscarballadares)
 - DinoWeb [dinoweb](http://github.com/dinoweb)
 - DinoWeb [dinoweb](http://github.com/dinoweb)

+ 3 - 1
doc/sluggable.md

@@ -272,6 +272,8 @@ Yaml mapped Article: **/mapping/yaml/Entity.Article.dcm.yml**
 
 
 ## Xml mapping example {#xml}
 ## Xml mapping example {#xml}
 
 
+**Note:** xml driver is not yet adapted for single slug mapping
+
     <?xml version="1.0" encoding="UTF-8"?>
     <?xml version="1.0" encoding="UTF-8"?>
     <doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
     <doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                       xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping">
                       xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping">
@@ -662,4 +664,4 @@ And the example usage:
 
 
 **Note:** tree slug handler, takes a parent relation to build slug recursively.
 **Note:** tree slug handler, takes a parent relation to build slug recursively.
 
 
-Easy like that, any suggestions on improvements are very welcome
+Any suggestions on improvements are very welcome