WordPress.org
Get WordPress

Plugin Directory

Changeset 1241549


Ignore:
Timestamp:
09/09/2015 01:25:35 PM (11 years ago)
Author:
VisualData
Message:

update readme and screen shots

Location:
custom-field-groups-for-pods
Files:
5 added
2 edited

Legend:

Unmodified
Added
Removed

  • custom-field-groups-for-pods/trunk/readme.txt

    r1238771 r1241549  
    1515Are you already using the awesome [PODS](https://wordpress.org/plugins/pods/) plugin to manage your custom content types and fields?
    1616
    17 Are you switching from Advanced Custom Fields to PODS but missing the location rules found in Advanced Custom Fields?
     17Are you switching from Advanced Custom Fields to PODS but missing the groups and location rules found in Advanced Custom Fields?
    1818
    19 Are you looking for a simple way to present your custom field data on your website in logical blocks?
     19Are you looking for a simple and easy way to present your custom field data on your website in logical blocks?
    2020
    2121CIO Custom Field Groups for PODS may be the solution you are looking for. It makes PODS even more awesome.
    2222
    23 CIO Custom Field Groups for PODS extends PODS to organize your custom fields into groups quickly and intuitively. The group headers are pods custom fields named with a prefix "cio_section_". Groups are defined by the relevant position of custom fields in pods setting page, so grouping and re-grouping can be done quickly by dragging and dropping meta boxes.
     23PODS is a powerful and flexible framework to manage custom content types and custom fields. Some of PODS's unique features include
     24
     25* extending WordPress's builtin content types (user, page, post, media, taxonomy)
     26
     27* table storage, which is essential for high performance as the number of custom fields increase.
     28
     29CIO Custom Field Groups for PODS extends PODS to organize your custom fields into groups quickly and intuitively. This is similar to reading a table of contents from a printed book, when we see a line starting with the word "Chapter" we KNOW it is a chapter and treat it as such. We can instruct the computer to do the same.
     30
     31The group headers are pods custom fields named with a prefix "cio_section_". Groups are defined by the relevant position of custom fields in pods setting page, so grouping and re-grouping can be done quickly by dragging and dropping meta boxes.
    2432
    2533The free version of CIO Custom Field Groups hooks into PODS form to automatically generate a row with label and description only, without input cells. Output of group header fields in the front end is optional depending on your pods field setting, page template and pods template.
    … …  
    2735Custom fields used as group headers are field definition only without any data saved to these fields. If you use pods table storage, you may set up group header fields as relationship fields so that such fields will not be created in your data table.
    2836
    29 PHP code is not required to use this plugin. However if you are comfortable with PHP code, you may instantiate the class in this plugin and use class methods to manipulate the custom fields and groups in your page template.
     37PHP code is not required to use this plugin. However if you are comfortable with PHP code, you may instantiate the class in this plugin and use class methods to get a multi dimensional array of groups and fields with all the pods field settings. You can then manipulate the custom fields and groups in your page template.
    3038
    3139= CIO Custom Field Groups Premium Version =
    … …  
    3745* Configuring the header and footer field prefix, if you need to name the fields in a certain way for the database to integrate with other plugins/programs.
    3846
    39 * Configuring the header and footer field background in the admin panel.
     47* Configuring the header and footer field background in the admin panel, so you will work with your favourite colours.
    4048
    4149* Configuring the header and footer field css for frontend display.
    4250
    43 * Setting up restriction access and display conditions similar to location rules of Advanced Custom Fields (ACF).
     51* Setting up restriction access and display conditions similar to location rules of Advanced Custom Fields (ACF). So a group of fields can be displayed on a specified page or post, or pages or posts meeting certain criteria,
    4452
    45 * Supporting pods-form short code and field based magic tags such as {@my_header}.
     53* Supporting pods-form short code and field based magic tags enclosed in short code or included in pods template, such as {@my_header}.
    4654
    47 * Displaying sections of custom fields according to user roles or capabilities. For example, you may collect and display different information is the users are wholesalers. 
     55* Displaying sections of custom fields according to user roles or capabilities. For example, you may collect and display different information if the users are wholesalers. 
    4856
    4957* Display sections of custom fields on specified pages only.
    … …  
    5260
    5361
    54 CIO Custom Fields and Groups is an add-on to PODS but can be used to group custom fields created with other plugins. This is achieved by sharing the stored data between your plugin and PODS, thanks to the great work of PODS team.
     62CIO Custom Fields and Groups is an add-on to PODS but can be used to group custom fields created with other plugins. You simply expend the post type or custom post type with pods, create custom fields using the same name. Then you can use the features from Pods or this plugin to present your data already stored. This is achieved by sharing the stored data between your plugin and PODS, thanks to the great work of PODS team.
    5563
    5664Both the free and professional edition works in multisite environment.
    … …  
    6169[CIO Custom Fields and Groups Professional Edition](http://vipp.com.au/cio-custom-fields-importer/custom-field-groups-for-pods/) is also available for immediate download for a small once-off fee.
    6270
    63 =How does it work=
     71= How does it work =
    6472
    6573We believe things should be as simple and easy as it could be. We embrace this philosophy in our code and business model.
    … …  
    8088Similarly, CIO Custom Fields and Groups professional edition hooks into Pods to display a header and footer label only without an input cell.
    8189
    82 CIO Custom Fields and Groups uses builtin table structures of WordPress and PODS to define groups. No extra taxonomy or data is created. The professional edition of CIO Custom Fields and Groups supports PODS shortcode and magic tags in shortcode template.
     90CIO Custom Fields and Groups uses builtin table structures of WordPress and PODS to define groups. No extra taxonomy or data is created. The professional edition of CIO Custom Fields and Groups supports PODS shortcode and magic tags in shortcode template, and in the template component.
    8391
    8492To display a group defined by the header field "my_header" from a custom post type called "product" with id 123, you would use the following short code.
    8593
    8694`[pods name="product" id=123] {@my_header} [/pods]`
     95
     96Alternatively if you enable the component template, you can create a template containing the following line for example
     97
     98`<div class="my-custom-group-class"> {@my_header}  </div> `
     99
     100Let's assume the template is called "my header template", and then you may use the following short code to display the group.
     101
     102`[pods name="product" id=123 template="my header template"]`
     103
     104= Output from pods functions =
     105
     106$pod->field($my_header): null
     107
     108$pod->fields(): all the fields including header fields
     109
     110$pod->display($my_header): null
     111
     112If you are using PODS and in some web pages looping through all fields to display content or form, after you have activated this plugin and created header fields, your existing code should still work without modification. The header fields will simply display a label for human comprehension.
    87113
    88114When CIO Custom Fields and Groups professional edition is activated, and preset display conditions are met, the custom fields belong to this group will be displayed.
    … …  
    1361621. define groups by field sequence. color coded group headers ($head -> sky => blue) and footers ($foot -> grass => green). configurable settings.
    137163
    138 2. location rules to display (posts only)
     1642. location rules to display (display on posts only)
    139165
    140 3. location rules to display (post name contains "demo" )
     1663. location rules to display (display when post name contains "demo" )
    141167
    1421684. shortcode and magic tags.
    143169
    144 5. location rules not met. (pods magic tag should disappear if conditions are not met. the magic tag shown here does not follow pods magic tag syntax and is treated as ordinary text. )
     1705. location rules not met. (pods magic tag should disappear if conditions are not met. the magic tag shown here does not follow pods magic tag syntax and is treated as ordinary text. PODS does not allow space between { and @)
    145171
    146 6. magic tags on post with "demo" in post title
     1726. location rules met. magic tags on post with "demo" in post title
    147173
    148 7. example of headers and footers in generated form. You may customise the display of headers and footers with CSS.   
     1747. example of headers and footers in generated display of grouped fields. You may customise the display of headers and footers with CSS.   
    149175
    1501768. access control of field groups.
    151177
    152 9. cio field group settings page.
     1789. cio field group settings page. choose your favoriate name and colours.
    153179
     18010. use header field in magic tag in template. You need to activate a pods component called "Template" to create templates.
     181
     18211. example of using template name in pods short code.
     183
     18412. location rules met. magic field of header is replaced with group fields.
     185
     18613. use the same short code in a page, the location rules are not met.
     187
     18814. location rules not met. a space was inserted between { and @ on purpose so the code will stay here for comparison.
    154189
    155190
Note: See TracChangeset for help on using the changeset viewer.