Improve docs

kaliop-uk · Aug 9, 2016 · 48cda28 · 48cda28
1 parent 8bb517f
commit 48cda28
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 55 deletions.
diff --git a/Resources/doc/DSL/ManageContent.yml b/Resources/doc/DSL/ManageContent.yml
@@ -16,18 +16,15 @@
         - attribute4: >
                       value on multiple
                       lines, but new line is not preserved on parsing
-        # image/binary file attribute example
+        # ezimage/ezbinaryfile file attribute example
         - attribute5:
-            type: ezimage/ezbinaryfile
-            path: '/path/to/image' # Relative path from Migrations/images/
+            path: '/path/to/image' # Relative path from MigrationsVersions/images/ or MigrationsVersions/files/
             alt_text: xyz #optional, only used for images
-        # xml text, using references
+        # ezxmltext, using references
         - attribute6:
-            type: ezxmltext
             content: '<section><paragraph><embed view="embed" size="medium" object_id="[reference:example_reference]" /></paragraph></section>'
         # Adding values to an ezauthor field
         - attribute7:
-            type: ezauthor 
             authors: 
               - 
                 name: Test Author 
@@ -36,7 +33,6 @@
                 name: Another Author 
                 email: [email protected]
 
-
     # The list in references tells the manager to store specific values for later use
     # by other steps in the current migration.
     references: #Optional
@@ -49,6 +45,15 @@
     mode: update
     object_id: x # The id of the object to update.
     remote_id: xxx # The 'remote_id' of the object to update. Can be used as alternative to the object_id. NB: this does *not* mean 'set the remote-id to what I want'
+    match: # An alternative to object_id and remote_id specified directly. NB: only one of the 3 can be used.
+           # Specify ONLY ONE of the following, to match a content or a set of contents
+        - content_id: x # int|int[]
+        - content_remote_id: xxx # string|string[]
+        - content_id: x # int|int[]
+        - content_remote_id: xxx # string|string[]
+        - parent_location_id: x # int|int[]
+        - parent_location_remote_id: xxx # string|string[]
+        - content_type: yyy # string|string[] a content type identifier
     attributes: # the list of attribute identifier value pairs
         - attribute1: value1
         - attribute2: value2
@@ -63,7 +68,18 @@
     type: content
     mode: delete
     object_id: x # the content/object id or a list of ids
-    remote_id: x # the content/object id or a list of ids. Used when object_id is not set
+    remote_id: x # the content/object id or a list of ids. Used when object_id and match are not set
+    match: # An alternative to object_id and remote_id specified directly. NB: only one of the 3 can be used.
+           # Specify ONLY ONE of the following, to match a content or a set of contents
+        - content_id: x # int|int[]
+        - content_remote_id: xxx # string|string[]
+        - content_id: x # int|int[]
+        - content_remote_id: xxx # string|string[]
+        - parent_location_id: x # int|int[]
+        - parent_location_remote_id: xxx # string|string[]
+        - content_type: yyy # string|string[] a content type identifier
+
+# Other examples for how to identify objects to delete
 
 -
     type: content
@@ -81,4 +97,4 @@
     # Sequences with the standard list syntax
     object_id: - id1
                - id2
-               - id3
+               - id3
diff --git a/Resources/doc/DSL/ManageContentType.yml b/Resources/doc/DSL/ManageContentType.yml
@@ -2,10 +2,10 @@
     type: content_type
     mode: create
     content_type_group: x # Id of the group we want to put the new content class into
-    name: xyz # Name of new class
     identifier: xyz # Class identifier
+    name: xyz # Name of new class
+    name_pattern: pattern # Pattern to use for the name of the object (ex: <title>)
     description: xyz # Optional
-    name_pattern: pattern # Optional, pattern to use for the name of the object (ex: <title>)
     url_name_pattern: pattern # Optional
     is_container: true|false # Optional, defaults to false
     attributes:
@@ -21,14 +21,14 @@
             category: default|meta # Optional
             default-value: # Optional
             field-settings: array # Optional, can be used for various field type specific settings
-    # The list in references tells the manager to store specific values for later use
-    # by other steps in the current migration.
+    # The list in references tells the manager to store specific values for later use by other steps in the current
+    # migration.
     references: #Optional
         -
-            identifier: referenceID # A string used to identify the reference
-            attribute: attributeId # An attribute to get the value of for the reference (supports content type id and content type identifier)
-                                   # The shorthand 'id' can be used instead of 'content_type_id
-                                   # The shorthand 'identifier' can be used instead of 'content_type_identifier
+            identifier: referenceId # A string used to identify the reference
+            attribute: attributeId # An attribute to get the value of for the reference. Supports content type id and content type identifier
+                                   # The shorthand 'id' can be used instead of 'content_type_id'
+                                   # The shorthand 'identifier' can be used instead of 'content_type_identifier'
 
 -
     type: content_type
@@ -64,8 +64,8 @@
             -
                 identifier: referenceId # A string used to identify the reference
                 attribute: attributeId # An attribute to get the value of for the reference (supports content type id and content type identifier)
-                                       # The shorthand 'id' can be used instead of 'content_type_id
-                                       # The shorthand 'identifier' can be used instead of 'content_type_identifier
+                                       # The shorthand 'id' can be used instead of 'content_type_id'
+                                       # The shorthand 'identifier' can be used instead of 'content_type_identifier'
 
 -
     # Delete a content type
@@ -79,45 +79,45 @@
 
 # Object Relation List
     -
-      identifier: class_identifier
-      type: ezobjectrelationlist
-      name: Name
-      description: Description of stuff
-      required: false
-      searchable: true
-      info-collector: false
-      disable-translation: false
-      category: meta
-      field-settings:
-        selectionDefaultLocation: reference:some_reference_location_id # OR a location ID
-        selectionContentTypes: [content_type_identifier] #This MUST be an array
-        selectionMethod: 0 # 0 is browse - 1 is dropdown
-      position: 60
+        identifier: class_identifier
+        type: ezobjectrelationlist
+        name: Name
+        description: Description of stuff
+        required: false
+        searchable: true
+        info-collector: false
+        disable-translation: false
+        category: meta
+        field-settings:
+          selectionDefaultLocation: reference:some_reference_location_id # OR a location ID
+          selectionContentTypes: [content_type_identifier] # This MUST be an array
+          selectionMethod: 0 # 0 is browse - 1 is dropdown
+        position: 60
 
 # Object Relation
     -
-      identifier: image
-      type: ezobjectrelation
-      name: Image
-      description: The image to use for the article
-      required: false
-      searchable: true
-      info-collector: false
-      disable-translation: false
-      category: default
-      field-settings:
-        selectionRoot: reference:some_reference_location_id # OR a location ID
-      position: 50
+        identifier: image
+        type: ezobjectrelation
+        name: Image
+        description: The image to use for the article
+        required: false
+        searchable: true
+        info-collector: false
+        disable-translation: false
+        category: default
+        field-settings:
+          selectionRoot: reference:some_reference_location_id # OR a location ID
+        position: 50
 
 # Nova SEO Metas
     -
-      type: novaseometas
-      name: SEO Meta
-      identifier: seo_meta
-      description: The meta data settings for SEO
-      required: false
-      info-collector: false
-      searchable: false # CANNOT be searchable
-      disable-translation: false
-      category: meta
-      position: 130
+        type: novaseometas
+        name: SEO Meta
+        identifier: seo_meta
+        description: The meta data settings for SEO
+        required: false
+        info-collector: false
+        searchable: false # CANNOT be searchable
+        disable-translation: false
+        category: meta
+        position: 130