tombenner

<p>Hierarchical Documentation allows admins to create public pages of documentation and organize them hierarchically using a tree listing the pages where each page can be dragged to its desired position. It supports syntax highlighting for blocks of code and <a href="http://daringfireball.net/projects/markdown/" rel="nofollow ugc">Markdown</a>.</p>
<p>For an example of Hierarchical Documentation in action, see <a href="http://wpmvc.org/" rel="nofollow ugc">wpmvc.org</a>.</p>
<p>Please note that the default behavior is to display the documentation page that has an ID of 1 as the site’s homepage. This can be changed by editing the first line of <code>hierarchical-documentation/app/config/routes.php</code>. (See the <a href="http://wpmvc.org/documentation/62/routing/" rel="nofollow ugc">WP MVC documentation page on routing</a> for details.)</p>
<p>This plugin depends on <a href="https://wordpress.org/extend/plugins/wp-mvc/" rel="ugc">WP MVC</a>, so that plugin needs to be installed and activated before this one is activated.</p>
<p>If you’d like to grab development releases, see what new features are being added, or browse the source code please visit the <a href="http://github.com/tombenner/hierarchical-documentation" rel="nofollow ugc">GitHub repo</a>.</p>


Hierarchical Documentation

Lets admins create searchable, hierarchically-organized documentation. Supports Markdown and syntax highlighting for code. Requires WP MVC.

Olivier D. aka oliezekat

<blockquote>
<p>Back WordPress API to the content.</p>
</blockquote>
<p>You can request some* functions of WordPress API with same syntax for arguments into your posts, pages, or widgets content.<br />
 functionsCapacitor will insert function result into your content as HTML output.</p>
<p>(*) see <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Supported-functions" rel="ugc">Supported functions</a><br />
or <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Supported-conditional-functions" rel="ugc">conditional tags</a>.</p>
<h4>Features</h4>
<ul>
<li>Safe process to use this plugin on WordPress MU or WP MultiSite.</li>
<li>Allow to personalize <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Embedded-output" rel="ugc">Embedded output</a><br />
for each functions.</li>
<li>Easy and powerfull <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Functions-arguments-syntax" rel="ugc">Functions arguments syntax</a><br />
to apply any WordPress API options.</li>
<li>Generic functions arguments with <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Magic-keywords" rel="ugc">Magic keywords</a>.</li>
<li>NEW: use <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Supported-conditional-functions" rel="ugc">WordPress conditional tags</a> as option to display a widget.</li>
<li>Structured source-code to prevent any conflict.</li>
</ul>
<p>Three methods to use WordPress API functions :</p>
<h4>Method by shortcode tag</h4>
<p>Insert a tag into your content like [fct function_name=”parameter1=value&parameter2=value”].</p>
<p>One shortcode tag can request several functions, input [fct function_name1=”arguments” function_name2=”arguments”].</p>
<h4>Method with a widget</h4>
<p>Add a functionsCapacitor widget, select a function, input function parameters like “parameter1=value&parameter2=value” (without quotes).</p>
<p>Optional: choose a <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Supported-conditional-functions" rel="ugc">supported conditional function</a> to decide where to display your widget.</p>
<h4>Method by custom fields</h4>
<p>Set a custom field name with function name and put function arguments into custom field value like “parameter1=value&parameter2=value” (without quotes).</p>
<ul>
<li>Result is always inserted at end.</li>
<li>Plugin has priority 5. Most plugins use priority 10.</li>
<li>This method is applied if post/page is displayed.</li>
</ul>
<h4>Examples</h4>
<ul>
<li>Tag cloud of popular posts tags,<br />
insert [fct wp_tag_cloud]</li>
<li>List of children pages of current page,<br />
insert [fct wp_list_pages=”title_li=&child_of=%postID%&depth=1″]</li>
<li>List of category’s recent posts with excerpts,<br />
insert [fct wp_get_recent_posts=”category=X&fct:show_excerpt=1″]<br />
with X equal category ID number</li>
<li>List of categories without default category,<br />
insert [fct wp_list_categories=”title_li=&exclude=%defaultcatID%”]</li>
</ul>
<h3>Embedded output</h3>
<p>Any functionsCapacitor request will insert <code><div class="functionsCapacitor">functions output</div></code>.<br />
 Shortcode method allow to personalize main container like<br />
 [fct container=”HTML tag name” class=”class(es) name(s)” style=”CSS properties” function1=”args” function2=”args”].<br />
 set container=”” to remove main container.</p>
<p>Some functions output were inserted with dedicated container like</p>
<ul>function output</ul>
<p>or <code><div class="function_name">function output</div></code>.<br />
 Personalize this container with <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Special-functions-parameters" rel="ugc">Special functions parameters</a>.</p>
<h3>Functions arguments syntax</h3>
<p>Follow these examples to setup your requests :</p>
<ul>
<li>“parameter1=something&parameter2=25”,<br />
parameter1 and parameter2 typed as strings.</li>
<li>“parameter1=something&parameter2=false”,<br />
parameter2 typed as boolean.</li>
<li>“parameter1=&parameter2= &parameter3=””,<br />
any parameters equal empty string.</li>
<li>“parameter1= something &parameter2=’ something ‘”,<br />
parameter1 equal ‘something’,<br />
parameter2 equal ‘ something ‘.</li>
<li>“parameter1=something&parameter2=array(‘something’,’something’)”,<br />
parameter2 typed as an array of 2 strings.</li>
<li>“parameter1=something&parameter2=array(10,5,20)”,<br />
parameter2 typed as an array of 3 integers.</li>
<li>“parameter1=something&parameter2=array(true,false)”,<br />
parameter2 typed as an array of 2 booleans.</li>
</ul>
<p>Not supported issues :</p>
<ul>
<li>parameter’s value can’t contain “&” or “=” characters.</li>
<li>parameter’s value can’t contain an associative array like array(‘name’=>value,’name’=>value).</li>
<li>parameter’s value can’t contain an array of arrays.</li>
<li>parameter’s value can’t contain a PHP variable like $post->ID,<br />
see <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Magic-keywords" rel="ugc">Magic keywords</a>.</li>
<li>parameter’s value can’t request a PHP or WordPress function.</li>
<li>parameter’s value can’t contain PHP source-code.</li>
</ul>
<h3>Magic keywords</h3>
<p>Use these keywords to obtain variables values into your functions arguments :</p>
<ul>
<li>%postID% => $post->ID,<br />
ID of post or page where made the request :<br />
related post/page into a shortcode,<br />
or current post/page into a widget.</li>
<li>%postparent% => $post->post_parent,<br />
ID of parent page where made the request.</li>
<li>%postauthor% => $post->post_author,<br />
author ID of post where made the request.</li>
<li>%defaultcatID% => default_category,<br />
ID of default category for newest posts.</li>
<li>%posttagIDs% => wp_get_post_tags(),<br />
string of current post tags IDs as “1,2,3,…”</li>
<li>%posttagslugs% => wp_get_post_tags(),<br />
string of current post tags slugs as “slug-name,slug-name,…”</li>
</ul>
<p>You can use magic keywords into an array.<br />
 Example: wp_list_categories=”exclude=array(%defaultcatID%,1,2,…)”</p>
<h3>Special functions parameters</h3>
<ul>
<li>fct:container to set HTML tag of function container.<br />
Set “fct:container=”” to remove this container.<br />
Each functions have a default container related to its output.</li>
<li>fct:container_id to set container “id” attribute.</li>
<li>fct:container_class to set container “class” attribute.<br />
Function name as default.<br />
Example with shortcode: [fct function_name=”fct:container_class=name&param1=value&param2=value”].</li>
<li>fct:container_style to set container “style” attribute.</li>
</ul>
<p>functionsCapacitor not create a container if the API function still return a container.<br />
 See <a href="https://codex.wordpress.org/Function_Reference" title="Wordpress documentation" rel="nofollow ugc">WordPress Codex</a> to personalize them.</p>
<h3>Supported functions</h3>
<ul>
<li>get_the_post_thumbnail()<br />
with size=thumbnail|medium|large|post-thumbnail<br />
or size name defined with add_image_size() into theme’s file functions.php.</li>
<li>get_the_tag_list()<br />
with before=”&sep=’ ‘&after=” as default,<br />
apply only on page or post,<br />
rendered into DIV container</li>
<li>wp_get_archives()<br />
with echo=0&format=html as default</li>
<li>wp_get_recent_posts()<br />
rendered as list with UL container,<br />
with exclude=%postID%&suppress_filters=false&post_status=publish&fct:perm=readable as default<br />
(see bellow)</li>
<li>wp_list_authors()<br />
with echo=0 as default</li>
<li>wp_list_bookmarks()<br />
with echo=0 as default</li>
<li>wp_list_categories()<br />
with echo=0 as default</li>
<li>wp_list_pages()<br />
with echo=0 as default</li>
<li>wp_nav_menu()<br />
with echo=false as default,<br />
see Codex to setting its container</li>
<li>wp_tag_cloud()<br />
with echo=0 as default,<br />
format=flat|list only</li>
</ul>
<p>See <a href="https://codex.wordpress.org/Function_Reference" title="Wordpress documentation" rel="nofollow ugc">WordPress Codex</a> about these functions and their arguments syntax.</p>
<p>Need you to support more functions, mail to oliezekat@yahoo.fr</p>
<h4>wp_get_recent_posts()</h4>
<ul>
<li>if fct:perm=readable hide draft, future, pending, protected posts<br />
but display private posts if user is allowed.</li>
<li>if fct:perm=” not output permalink of draft, future, pending, private posts.</li>
<li>set fct:show_excerpt=1|true to display posts excerpts.</li>
<li>set fct:show_date=1|true to display posts dates.</li>
<li>set fct:show_thumbnail=1|true to display post thumbnail,<br />
with fct:thumbnail_size=thumbnail|medium|large|post-thumbnail<br />
or size name defined with add_image_size() into theme’s file functions.php.</li>
<li>fct:show_thumbnail=true if fct:thumbnail_size is defined</li>
<li>display excerpt and thumbnail for draft, future, pending, private, and protected posts<br />
but not create an excerpt from content.</li>
</ul>
<h3>Supported conditional functions</h3>
<ul>
<li>cat_is_ancestor_of()<br />
check if current category is child of conditional argument.</li>
<li>in_category()</li>
<li>is_category()</li>
<li>is_front_page()</li>
<li>is_home()</li>
<li>is_page()</li>
<li>is_single()</li>
</ul>
<p>See <a href="https://codex.wordpress.org/Conditional_Tags" title="Wordpress documentation" rel="nofollow ugc">WordPress Conditional Tags</a> about these functions and their arguments syntax.</p>
<h4>Not canonical conditional functions</h4>
<p>These functions are designed for this plugin only, not available elsewhere, and not documented into the WordPress Codex.</p>
<ul>
<li>in_tree_of()<br />
check if page, post, or category is descendant of conditional argument (or itself),<br />
require argument as page or category numeric ID.</li>
<li>is_category_in_tree_of()<br />
check if category is descendant of conditional argument (or itself),<br />
require argument as category numeric ID.</li>
<li>is_page_descendant_of()<br />
check if page is descendant of conditional argument,<br />
require argument as page numeric ID.</li>
<li>is_page_in_tree_of()<br />
check if page is descendant of conditional argument (or itself),<br />
require argument as page numeric ID.</li>
<li>is_single_in_tree_of()<br />
check if post is in descendant of conditional argument,<br />
require argument as category numeric ID.</li>
</ul>
<h4>Conditional functions arguments syntax</h4>
<p>Support only arguments as single value ; string, numeric, or <a href="https://wordpress.org/extend/plugins/functionscapacitor/other_notes/#Magic-keywords" rel="ugc">magic keyword</a>.</p>


functionsCapacitor

This plugin allow to apply some WordPress API's functions into your post/page content or as a widget.

Hierarchical Documentation vs functionsCapacitor