Changeset 1804034

Timestamp:

01/16/2018 08:51:10 PM (7 years ago)

Author:

JorgeAmVF

Message:

better-formed readme.txt file provided

Location:

catag/trunk

Files:

• catag.php (modified) (2 diffs)
• readme.txt (modified) (1 diff)

catag/trunk/catag.php

@@ -2 +2 @@
 /*
 * Plugin Name: autometa's CATAG
-* Description: It reproduces categories and tags and it generates a cloud mixing categories and tags of posts simply via: [cats] and [tags] and [catag].
-* Version: 1.2
+* Description: It reproduces post categories and tags in posts and it generates a cloud mixing categories and tags of posts simply via: [cats] and [tags] and [catag].
+* Version: 2.0
 * Author: JorgeAmVF
 * Author URI: https://profiles.wordpress.org/jorgeamvf/
@@ -26 +26 @@
 */
 
-// [cats] = categories (post)
-function autometa_post_categories($atts, $content = null){
-global $post;
-$autometascategories = get_the_category_list($separator = ' ', $post->ID);
- return '<div id = "cats" class = "autometa">' . $autometascategories . '</div>';
+// [cats] = (post) categories
+function autometa_post_categories( $atts, $content = null ) {
+    global $post;
+    $am_cats = '<span id="cats" class="autometa">' .get_the_category_list( $separator = ' ', $post->ID ) . '</span>';
+        return $am_cats;
 }
-add_shortcode("cats","autometa_post_categories");
+add_shortcode( "cats", "autometa_post_categories" );
 
-// [tags] = tags (post)
-function autometa_post_tags($atts, $content = null){
-global $post;
-$autometastags = get_the_term_list($post->ID, 'post_tag', $separator = ' ');
- return '<div id = "tags" class = "autometa">' . $autometastags . '</div>';
+// [tags] = (post) tags
+function autometa_post_tags( $atts, $content = null ) {
+    global $post;
+    $am_tags = '<span id="tags" class="autometa">' . get_the_term_list( $post->ID, 'post_tag', $separator = ' ' ) . '</span>';
+        return $am_tags;
 }
-add_shortcode("tags","autometa_post_tags");
+add_shortcode( "tags", "autometa_post_tags" );
 
-// [catag] = categories & tags (post)
-function autometa_post_taxonomy($echo = false){
- if (function_exists('wp_tag_cloud'))
-  return wp_tag_cloud(array('number' => 0, 'orderby' => 'count', 'order' => 'RAND', 'taxonomy' => array('post_tag', 'category'),));
+// [catag] = (post) categories & tags
+function autometa_post_taxonomies( $echo = false ) {
+    if ( function_exists( 'wp_tag_cloud') )
+        $am_catag  = '<span id="catag" class="autometa">' . wp_tag_cloud( array(
+            'number' => 0,
+            'orderby' => 'count',
+            'order' => 'RAND',
+            'taxonomy' => array(
+                'post_tag',
+                'category'
+            ),
+        ) ) . '</span>';
+            return $am_catag;
 }
-add_shortcode("catag","autometa_post_taxonomy");
+add_shortcode( "catag", "autometa_post_taxonomies" );
 ?>

catag/trunk/readme.txt

@@ -4 +4 @@
 Tags: shortcode, automation, metadata, taxonomy, cloud, category, tag
 Requires at least: 2.5.0
-Tested up to: 4.8.1
+Tested up to: 4.9.1
 Stable Tag: trunk
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
-It reproduces categories and tags and it generates a cloud mixing categories and tags of posts simply via: [cats] and [tags] and [catag].
+It reproduces categories and tags in posts and it generates a cloud mixing categories and tags of posts simply via: `[cats]` and `[tags]` and `[catag]`.
 == Description ==
  
 **autometa's CATAG** is a simple plugin that uses the following shortcodes:
 
-* *[cats]*  = to reproduce the categories of a post;
-* *[tags]*  = to reproduce the tags of a post;
-* *[catag]* = to generate a taxonomy cloud mixing categories and tags of posts.
+* `[cats]`  = to reproduce post categories;
+* `[tags]`  = to reproduce post tags;
+* `[catag]` = to generate a taxonomy cloud mixing categories and tags of posts.
 
-**autometa's CATAG** is an element of **[autometa](https://wordpress.org/plugins/autometa/)** plugin set.
-
-== Installation ==
-
-1. Download it or install it to your plugin folder;
-2. Activate it from the plugin tab inside your dashboard;
-3. Write the following shortcodes in text fields of posts: *[cats]*, *[tags]*, *[catag]*.
+**autometa's CATAG** is a standalone component of **[autometa](https://wordpress.org/plugins/autometa/)** shortcodes pack.
 
 == Frequently Asked Questions ==
 
-= How does autometa's CATAG work? =
+= Installation Instructions =
 
-**[autometa](https://wordpress.org/plugins/autometa/)** reproduces metadata information automatically via shorcodes in general, **autometa's CATAG** reproduces categories and tags of posts in special.
+1. Install it from *Dashboard*/*Plugins*/*Add Plugins* or download it to your plugin folder;
+2. Activate it from *Dashboard*/*Plugins*/*Installed Plugins*;
+3. Write the following shortcodes in text fields:  `[cats]`, `[tags]`, `[catag]`.
 
-= What is needed to use autometa's CATAG? =
+= Plugin Features =
 
-Just write one or more of the following shortcodes inside a text field of a post and between brackets as usual: *[cats]* and/or *[tags]* and/or *[catag]*.
+**[autometa](https://wordpress.org/plugins/autometa/)** reproduces metadata information automatically via shorcodes in general, **autometa's CATAG** reproduces post taxonomy-related data in special.
 
-= Where should autometa's CATAG be placed? =
+= How To =
 
-*[cats]* and *[tags]* must be written only inside a text field of a post since it might crash the page if the referred shortcodes are written inside pages, portfolios or products whether the plugin is active once there is no correspondent taxonomy to be reproduced in those environments; otherwise, as *[catag]* reproduces categories and tags from all posts, it can be easily placed inside pages, posts, portfolios or products at ease.
+Just write one or more of the following shortcodes inside a text field and between brackets as usual: `[urlug]` and/or `[urlink]` and/or `[urlinked]`.
 
-= Which functions are used by autometa's CATAG? =
+= CSS Style Selectors =
 
-These: [`add_shortcode()`](https://developer.wordpress.org/reference/functions/add_shortcode/) and [`get_the_category_list()`](https://developer.wordpress.org/reference/functions/get_the_category_list/) and [`get_the_term_list()`](https://developer.wordpress.org/reference/functions/get_the_term_list/) and [`wp_tag_cloud()`](https://developer.wordpress.org/reference/functions/wp_tag_cloud/).
+* `#cats`     = `[cats]` ID;
+* `#tags`     = `[tags]` ID;
+* `#catag`    = `[catag]` ID;
+* `.autometa` = **autometa** class.
+
+= PHP Functions Reference =
+
+* [`add_shortcode()`](https://developer.wordpress.org/reference/functions/add_shortcode/)
+* [`get_the_category_list()`](https://developer.wordpress.org/reference/functions/get_the_category_list/)
+* [`get_the_term_list()`](https://developer.wordpress.org/reference/functions/get_the_term_list/)
+* [`wp_tag_cloud()`](https://developer.wordpress.org/reference/functions/wp_tag_cloud/)