web/wp-content/plugins/page2cat/readme.txt
changeset 194 32102edaa81b
parent 136 bde1974c263b
child 204 09a1c134465b
equal deleted inserted replaced
193:2f6f6f7551ca 194:32102edaa81b
     1 === Category Page ===
     1 === Category Pages & Posts Shortcodes ===
     2 Contributors: pixline
     2 Contributors: swergroup, pixline
     3 Donate link: http://tinyurl.com/375yrk
     3 Donate link: https://bitly.com/Vpy3MP
     4 Tags: admin, pages, category, formatting, plugin, categories, integration, page, theme
     4 Tags: category, categories, pages, posts, page, post, integration, shortcode, shortcodes, list, archives
     5 Requires at least: 2.2
     5 Requires at least: 3.4.2
     6 Tested up to: 2.5
     6 Tested up to: 3.4.2
     7 Stable tag: 2.5
     7 Stable tag: trunk
       
     8 License: GPLv2
       
     9 License URI: http://www.gnu.org/licenses/gpl-2.0.html
     8 
    10 
     9 Use pages as category archive header, or list some posts from a category into a post/page. 
    11 Useful shortcodes to display a post or page content or a list of posts.
    10 
    12 
    11 == Description ==
    13 == Description ==
    12 
    14 
    13 This plugin will let you setup connection between pages and categories, in order to display the page content like a "header" for your category archive (theme tweak required). By popular demand, version 2.5 also ships with a shortcode like [catlist] that allows to display a list of posts from a certain category inside a post or a page. 
    15 Category Pages & Posts Shortcodes is a complete rewrite of the "Category Page" plugin.
    14 . 
    16 It offers useful shortcodes to display a post or page content, or a list of posts.
    15 Copyright (C) 2008 Paolo Tresso / [Pixline](http://pixline.net/)
    17 Also it allow exclusive mutual bind between a Category and a Page, in order to display the page content as "header" of category archives. 
    16 
    18 
    17 [plugin page](http://pixline.net/wordpress-plugins/category-page-plugin/en/) - [support forum](http://talks.pixline.net/forum/category-page-plugin)
    19 You can safely use shortcodes inside a post or a page, our you can embed them in your theme 
       
    20 using the [do_shortcode](http://codex.wordpress.org/Function_Reference/do_shortcode) WordPress function like that:
       
    21 
       
    22 `<?php do_shortcode('[showsingle pageid="<id_of_page>"]'); ?>`
       
    23 
       
    24 NOTE: This plugin requires WordPress 3.4.x, and will **break** your current ~2.5 setup.
       
    25 It also won't be compatible with [Category Page Extender](http://categorypageextender.wordpress.com) anymore. 
       
    26 On activation, it will clean every option set by the previous versions. Please test it offline first.
       
    27 
       
    28 = [showsingle pageid="" postid="" showheader="" header="" headerclass="" wrapper="" wrapperclass=""] =
       
    29 
       
    30 This shortcode will show a single post or page. The only required argument is either *postid* or *pageid*.
       
    31 
       
    32 * **pageid** - ID of the page you want to display (either this or postid)
       
    33 * **postid** - ID of the post you want to display (either this or pageid)
       
    34 * **showheader** - if *"true"*, show the page title
       
    35 * **header** - level of title HTML header (from 1 to 6, 2 default)
       
    36 * **headerclass** - header custom CSS class (default: `aptools-single-header`)
       
    37 * **wrapper** - if *"true"*, wraps the whole output with `<div class="aptools-wrapper"></div>`
       
    38 * **wrapperclass** - wrapper custom CSS class (default: `aptools-wrapper`)
       
    39 
       
    40 = [showlist catid="" lenght="" listclass="" excerpt="" wrapper="" wrapperclass=""] =
       
    41 
       
    42 This shortcode will show a list of posts from you. Required argument is catid.
       
    43 
       
    44 * **catid** - ID (**not** slug, nor name) of the category you want to list
       
    45 * **lenght** - how many posts listed (default: 10. don't set it too high..)
       
    46 * **listclass** - list element's custom CSS class (default: `aptools-list`) 
       
    47 * **excerpt** - if *true* shows excerpt alongside title
       
    48 * **wrapper** - if *"true"*, wraps the whole output with `<div class="aptools-wrapper"></div>`
       
    49 * **wrapperclass** - wrapper custom CSS class (default: `aptools-wrapper`)
       
    50 
       
    51 = [showauto] =
       
    52 
       
    53 This shortcode works only on category archives templates: it will display on each category the linked page content.
       
    54 You can set up the link either on the page edit admin area or in the category edit area. 
       
    55 Please note: a single page can be linked this way to a single category only. 
       
    56 If you need more flexible options you should take advantage of [WordPress template hierarchy](http://codex.wordpress.org/Template_Hierarchy): 
       
    57 you can create a `category-<category_name>.php` file with a `[showsingle]` shortcode. 
       
    58 
       
    59 
       
    60 GPL2(C) 2008+ [SWER Siti internet Torino](http://swergroup.com/)
       
    61 
       
    62 [Git source code on Bitbucket](http://dev.swergroup.com/pages-and-posts-shortcodes)
       
    63 
       
    64 [Support Forum on wordpress.org](http://wordpress.org/support/plugin/page2cat)
    18 
    65 
    19 == Installation ==
    66 == Installation ==
    20 
    67 
    21 1. Download the plugin Zip archive.
    68 1. Download the plugin, unzip, upload folder to your `/wp-content/plugins/` directory
    22 1. Upload `Category Page` folder to your `/wp-content/plugins/` directory
       
    23 1. Activate the plugin through the 'Plugins' menu in WordPress
    69 1. Activate the plugin through the 'Plugins' menu in WordPress
    24 1. Setup some relationship between Categories and Pages
    70 1. Look for the documentation on the plugin page and learn how to use it.
    25 1. Tweak `archive.php` in your theme folder (while I write documentation, please [read here](http://talks.pixline.net/topic.php?id=13#post-32) to learn how).
       
    26 1. Enjoy!
    71 1. Enjoy!
    27 
    72 
    28 [plugin page](http://pixline.net/wordpress-plugins/category-page-plugin/en/) - [support forum](http://talks.pixline.net/forum/category-page-plugin)
    73 == Frequently Asked Questions ==
    29 
    74 
       
    75 = Is this plugin supported? =
       
    76 
       
    77 We'll try our best to support it on the [support forum](http://wordpress.org/support/plugin/page2cat).
       
    78 If you rely on this plugin for commercial purposes please get in touch with our [helpdesk](http://swergroup.zendesk.com).
       
    79 
       
    80 = I used to see [page|menu|box] Category Page, where is it? =
       
    81 
       
    82 It probably isn't here. WordPress changed a lot since 2007. 
       
    83 
       
    84 You should be able to solve with shortcodes quite everything you were used to. If you can't manage it drop us a line in the support forum and we'll try to find a solution.
       
    85 
       
    86 = Why you didn't update Category Page and rewrote it instead? =
       
    87 
       
    88 The original concept and codebase were obsolete, with a lot of logic flaws. We just couldn't avoid it.
       
    89 
       
    90 = Where is the last pre 3.0 version? =
       
    91 
       
    92 Last pre-3.0 version is 2.6.3, [SVN r367559](http://plugins.trac.wordpress.org/browser/page2cat?rev=367559)
       
    93 
       
    94 You can download it by SVN client: 
       
    95 
       
    96 `svn -r 367559 checkout http://plugins.svn.wordpress.org/page2cat/trunk/ page2cat-2.6.3`
       
    97 
       
    98 == Screenshots ==
       
    99 
       
   100 1. Sample page inclusion as an archive page header via [showsingle]
    30 
   101 
    31 == Changelog ==
   102 == Changelog ==
    32 
   103 
    33 * 2.5	(26/03/07) WordPress 2.5 compliance. Theme examples released as separate theme pack.
   104 = 3.0.6 =
    34 * 0.4.4 (03/09/07) fix content filters. 2.3 compliant release.
   105 * (11/11/2012) FIX Warning on admin Page area. 
    35 * 0.4.3 (30/08/07) 2.3beta1-compliant release
   106 * (11/11/2012) FIX Better headers and descriptions
    36 * 0.4.2 (22/08/07) microbugfix, example files for Kubrik, Hemingway and Sandbox themes.
   107 * (11/11/2012) FIX [showauto] formatting and styles
    37 * 0.4.1 (15/08/07) fix 'foreach' errors
   108 
    38 * 0.4	(10/08/07) stable release for 0.4. going to the next level.
   109 = 3.0.5 =
    39 * 0.4b2 (06/08/07) fix for db version...
   110 * (11/11/2012) Fix error on the admin Page area. 
    40 * 0.4b  (05/08/07) TESTING RELEASE svn only. moved to database, plugin almost rewritten from scratch. 
   111 
    41 * 0.3	(27/07/07) many fixes for 2.1.3, 2.2.1 and svn compatibility. archive.php example fixed.
   112 = 3.0.3 =
    42 * 0.2.1 (19/07/07) fixed backward compatibility for 2.1
   113 * (10/11/2012) Better descriptions in edit-page and edit-category forms
    43 * 0.2   (18/07/07) management and options panel, better sidebox, widget available, one more example theme. 
   114 * (10/11/2012) Fix links
    44 * 0.1	(17/07/07) first tag. alpha 2 with some typo fixing.
   115 
    45 * 0.1a2 (17/07/07) fix sidebox in page editing, manage panel. 
   116 = 3.0.2 =
    46 * 0.1a  (16/07/07) first public alpha.
   117 * (04/11/2012) showlist query fix.
    47 `
   118 
       
   119 = 3.0.1 =
       
   120 * (03/11/2012) *[showlist]* shortcode fix, category › page link restored.
       
   121 
       
   122 = 3.0 =
       
   123 * (30/10/2012) Complete rewrite for WordPress 3.4+
       
   124 
       
   125 == Upgrade Notice ==
       
   126 
       
   127 = 3.0.6 =
       
   128 * (11/11/2012) FIX warning on admin page area, [showauto] formatting, headers and descriptions.
       
   129 
       
   130 = 3.0.5 =
       
   131 * (11/11/2012) Fix error on the admin Page area. 
       
   132 
       
   133 = 3.0.3 =
       
   134 CAUTION: This plugin requires WordPress 3.4.x, and will **break** your WP 2.5 setup.
       
   135 - Better descriptions in edit-page and edit-category forms
       
   136 - Fix links
       
   137 
       
   138 = 3.0.2 = 
       
   139 CAUTION: This plugin requires WordPress 3.4.x, and will **break** your WP 2.5 setup.
       
   140 FIX showlist category query.
       
   141 
       
   142 = 3.0 =
       
   143 This plugin requires WordPress 3.4.x, and will **break** your WP 2.5 setup.
       
   144 It also won't be compatible with [Category Page Extender](http://categorypageextender.wordpress.com) anymore. 
       
   145 On activation, it will clean every option set by the previous versions. Please test it offline first.
       
   146