WordPress.org
Get WordPress

Plugin Directory

Changeset 2154247


Ignore:
Timestamp:
09/10/2019 02:03:12 PM (7 years ago)
Author:
coder618
Message:

Readme edit for typo and etc.

Location:
render-posts
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • render-posts/tags/1.0/readme.txt

    r2152114 r2154247  
    1111
    1212== Description ==
    13 This plugin will help developer to show/render posts/custom posts(CPT) very easily.
    14 This plugin register a shortcode, which developer can use to render any kind of posts in your custom html formate where all you can you all your PHP function/condition available.
    15 This Plugin also have a function to load your post's by Ajax, Shortcode will automatically generate a Load More  Button if posts available.
    16 This plugin also support with Gutenberg.
     13This plugin will help the developer / user to show/render posts very easily regardless of the post type.
     14This plugin register a short-code, which developer/user can use to render any kind of posts, in a custom defined format.
     15This plugin also contains a (AJAX) load more feature, which help users to load remaining posts without leaving the page, (Also known as Ajax Pagination).
     16This plugin also support with Gutenberg (Because it's just a shortcode) .
    1717
    1818== Installation ==
    19 1. Upload the plugin folder to the `/wp-content/plugins` directory, or install the plugin through the WordPress plugins screen directly.
    20 1. Activate the plugin through the 'Plugins' screen in WordPress.
     19- Upload the plugin folder to the `/wp-content/plugins` directory, or install the plugin through the WordPress plugins screen directly.
     20- Activate the plugin through the 'Plugins' screen in WordPress Dashboard.
    2121
    2222This plugin do not have any settings page, so after install you just have to active the plugin, thats it.
    23 Then you can use [render-post] shortcode to render/show your posts.
     23Then you can use [render-post] shortcode.
    2424
    2525== Frequently Asked Questions ==
    … …  
    2828No, This plugin currently do not have any settings page. you just have to active the plugin to use.
    2929
    30 = Can i Render/Show Custom Post type by this plugin short code =
    31 Yes, You can, you have to provide type argument with your post type. eg [render-posts type="custom-post-type-name"]
     30= Can I Render/Show Custom Post type by this plugin short-code =
     31Yes, You can, you have to provide type argument with your post type. eg [render-posts type="custom-post-type-slug"]
    3232
    3333= How to render/show posts with my custom markup =
    3434To show post with you markup you have to define a function, which name will be a specific formate. eg. event_template(), member_template() etc. When you post type is event, member. Please see the Technical Documentation for more info.
    35 
    36 
    37 == Screenshots ==
    38 
    39 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
    40 the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
    41 directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
    42 (or jpg, jpeg, gif).
    43 2. This is the second screen shot
    4435
    4536== Changelog ==
    … …  
    5748Shortcode : [render-posts]
    5849Available Arguments :
    59 1. *type = "You Post type "
    60 1. number = "Posts Per Page" -- if not specify it will inherit from wordpress global posts_per_page option serttings.
    61 1. title = "Section title"
    62 1. detail = "Section Detail"
    63 1. noloadmore = "true" -- Set it if you dont want to show loadmore button
     50- *type = "You Post type "
     51- number = "Posts Per Page" -- if not specify it will inherit from wordpress global posts_per_page option serttings.
     52- title = "Section title"
     53- detail = "Section Detail"
     54- noloadmore = "true" -- Set it if you dont want to show loadmore button
    6455
    6556*required field.
    … …  
    6859
    6960== Technical documentation ==
    70 How to add Custom Post template.
     61How to add Custom Markup for a specific post type.
    7162
    72 To make a custom post template you have to crate a php function with a specific name.
    73 And Your function have to RETURN(NOT echo) the whole markup as a string. This function will have one argument post id.
     63To make a custom markup there are two steps:
     641. Crate a php function with a specific name.
     652. Add your created function in function.php or by other plugin so that your created function can be accessible by WordPress.
    7466
    75 Function Name: postType_template($post_id) ,
    76 eg: post_template($post_id) , event_template($post_id), member_template($post_id) for post, event and member Post Type.
     67= Function Naming =
     68- post_template()  -> when post type is post
     69- event_template()  -> when post type is event
     70- member_template()  -> when post type is member
     71
     72Your defined function will receive a single post id as its first argument. You can use this id to manipulate/make the specific posts markup.
     73
     74Note: Plugin will render sufficient amount of DIV with dynamic CLASS's (related with the post type name) at rendering,
     75which will help you to create any kind of layout very easily by using css.
    7776
    7877For Example function:
    7978Please Visit: [Github-Gist](https://gist.github.com/coder618/9228d07b7653d27e4978c051202e4e91)
    80 
    81 
    82 Your defined  template function will receive a single post id  as its first argument. You can use this id to manipulate/make the posts markup for post/cpt template.
    83 After create the function, you have to Attached/link your created function to function.php or via other plugin so that your created function can be accessible by WordPress.
    84 
    85 
    86 Note : You have to return the markup, you cant echo the markup from the function. It can  cause error.

  • render-posts/trunk/readme.txt

    r2152126 r2154247  
    1111
    1212== Description ==
    13 This plugin will help developer to show/render posts/custom posts(CPT) very easily.
    14 This plugin register a shortcode, which developer can use to render any kind of posts in your custom html formate where all you can you all your PHP function/condition available.
    15 This Plugin also have a function to load your post's by Ajax, Shortcode will automatically generate a Load More  Button if posts available.
    16 This plugin also support with Gutenberg.
     13This plugin will help developer/user to show/render posts very easily regurdless of the post type.
     14This plugin register a shortcode, which developer/user can use to render any kind of posts in a custom defined formate.
     15This plugin also containe a load more feature, where user can load more posts by ajax (Also known as Pagination).
     16This plugin also support with Gutenberg (Because its just a shorcode).
    1717
    1818== Installation ==
    19 1. Upload the plugin folder to the `/wp-content/plugins` directory, or install the plugin through the WordPress plugins screen directly.
    20 1. Activate the plugin through the 'Plugins' screen in WordPress.
     19- Upload the plugin folder to the `/wp-content/plugins` directory, or install the plugin through the WordPress plugins screen directly.
     20- Activate the plugin through the 'Plugins' screen in WordPress Dashboard.
    2121
    2222This plugin do not have any settings page, so after install you just have to active the plugin, thats it.
    23 Then you can use [render-post] shortcode to render/show your posts.
     23Then you can use [render-post] shortcode.
    2424
    2525== Frequently Asked Questions ==
    … …  
    2828No, This plugin currently do not have any settings page. you just have to active the plugin to use.
    2929
    30 = Can i Render/Show Custom Post type by this plugin short code =
    31 Yes, You can, you have to provide type argument with your post type. eg [render-posts type="custom-post-type-name"]
     30= Can I Render/Show Custom Post type by this plugin short-code =
     31Yes, You can, you have to provide type argument with your post type. eg [render-posts type="custom-post-type-slug"]
    3232
    3333= How to render/show posts with my custom markup =
    3434To show post with you markup you have to define a function, which name will be a specific formate. eg. event_template(), member_template() etc. When you post type is event, member. Please see the Technical Documentation for more info.
    35 
    36 
    37 == Screenshots ==
    38 
    39 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
    40 the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
    41 directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
    42 (or jpg, jpeg, gif).
    43 2. This is the second screen shot
    4435
    4536== Changelog ==
    … …  
    5748Shortcode : [render-posts]
    5849Available Arguments :
    59 1. *type = "You Post type "
    60 1. number = "Posts Per Page" -- if not specify it will inherit from wordpress global posts_per_page option serttings.
    61 1. title = "Section title"
    62 1. detail = "Section Detail"
    63 1. noloadmore = "true" -- Set it if you dont want to show loadmore button
     50- *type = "You Post type "
     51- number = "Posts Per Page" -- if not specify it will inherit from wordpress global posts_per_page option serttings.
     52- title = "Section title"
     53- detail = "Section Detail"
     54- noloadmore = "true" -- Set it if you dont want to show loadmore button
    6455
    6556*required field.
    … …  
    6859
    6960== Technical documentation ==
    70 How to add Custom Post template.
     61How to add Custom Markup for a specific post type.
    7162
    72 To make a custom post template you have to crate a php function with a specific name.
    73 And Your function have to RETURN(NOT echo) the whole markup as a string. This function will have one argument post id.
     63To make a custom markup there are two steps:
     641. Crate a php function with a specific name.
     652. Add your created function in function.php or by other plugin so that your created function can be accessible by WordPress.
    7466
    75 Function Name: postType_template($post_id) ,
    76 eg: post_template($post_id) , event_template($post_id), member_template($post_id) for post, event and member Post Type.
     67= Function Naming =
     68- post_template()  -> when post type is post
     69- event_template()  -> when post type is event
     70- member_template()  -> when post type is member
     71
     72Your defined function will receive a single post id as its first argument. You can use this id to manipulate/make the specific posts markup.
     73
     74Note: Plugin will render sufficient amount of DIV with dynamic CLASS's (related with the post type name) at rendering,
     75which will help you to create any kind of layout very easily by using css.
    7776
    7877For Example function:
    7978Please Visit: [Github-Gist](https://gist.github.com/coder618/9228d07b7653d27e4978c051202e4e91)
    80 
    81 
    82 Your defined  template function will receive a single post id  as its first argument. You can use this id to manipulate/make the posts markup for post/cpt template.
    83 After create the function, you have to Attached/link your created function to function.php or via other plugin so that your created function can be accessible by WordPress.
    84 
    85 
    86 Note : You have to return the markup, you cant echo the markup from the function. It can  cause error.
Note: See TracChangeset for help on using the changeset viewer.