From 8aed3b17273687547a4a66a35d67eef3c5b934a5 Mon Sep 17 00:00:00 2001
From: John Bintz
Date: Thu, 19 Nov 2009 20:54:57 -0500
Subject: [PATCH] doc tweaks
---
docs/en_US/storyline-post-template-tags.html | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/docs/en_US/storyline-post-template-tags.html b/docs/en_US/storyline-post-template-tags.html
index fa60769..eb11eff 100644
--- a/docs/en_US/storyline-post-template-tags.html
+++ b/docs/en_US/storyline-post-template-tags.html
@@ -1,5 +1,10 @@
Storyline Post Template Tags
+
+ ComicPress Core provides a number of functions that allow you to traverse the storyline structure created from your blog's categories.
+ Technical details about these template tags can be found in the functions.inc
file within your ComicPress Core installation.
+
+
R() and RT()
@@ -11,11 +16,11 @@
// use a post programmatically
$previous_post = R('previous');
-echo get_the_permalink($previous_post->ID);
+echo get_permalink($previous_post);
// use template tags with a post
Protect(); // save the current Loop post
-RT('previous');
+$previous_post = RT('previous'); // RT() returns the post, too
the_permalink();
Restore(); // restore the saved Loop post
@@ -161,12 +166,12 @@ R('previous', null, $other_post);
- - child_of => category slug: Search for matching posts in the provided category and its children.
- - only => category slug: Search only the provided category.
+ - child_of => category ID or slug: Search for matching posts in the provided category and its children.
+ - only => category ID or slug: Search only the provided category.
- root_of => post ID or object: Find the root category the post belongs to and search for posts from that category and in all children.
- from_post => post ID or object: Search for matching posts in the category this post belongs to.
- - previous => category slug: Search for matching posts in the category before the provided category as defined in the storyline structure.
- - next => category slug: Search for matching posts in the category after the provided category as defined in the storyline structure.
+ - previous => category ID or slug: Search for matching posts in the category before the provided category as defined in the storyline structure.
+ - next => category ID or slug: Search for matching posts in the category after the provided category as defined in the storyline structure.
- level => storyline level: Search for posts in the categories defined at this level in the storyline structure, with level 1 being the topmost categories, level 2 being their direct children, etc.
@@ -258,4 +263,4 @@ $parent = SC('parent');
// or you can provide a category to be relative to
$next_from_three = SC('next', 3);
$previous_to_chapter_four = SC('previous', 'chapter-four');
-
\ No newline at end of file
+