github-migration/comicpress-core
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more documentation work

Browse Source
This commit is contained in:
John Bintz 2009-11-19 21:27:40 -05:00
parent e6e91e3eb6
commit a5d2a62745
4 changed files with 129 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/en_US/media-embed-template-tags.html
View File

@ -1,14 +1,14 @@
<h1>Media Embedding Template Tags</h1> <h1>Media Embedding Template Tags</h1>
<p> <p>
<em>ComicPress Core</em> provides a handful of template tags to access the media attached to each post. <em>ComicPress Core</em> provides a handful of template tags to access the media attached to each post.
</p> </p>
<h2>M()</h2> <h2>M()</h2>
<p> <p>
<code>M()</code> retrieves the attachment info from the current post. <code>M()</code> retrieves the attachment info from the current post.
Attachment info is returned as an array of IDs that the various backends can identify and work with: Attachment info is returned as an array of IDs that the various backends can identify and work with:
</p> </p>
<pre class="prettyprint lang-php"> <pre class="prettyprint lang-php">
@ -18,6 +18,20 @@ foreach (M() as $image) { echo EM($image); }
// we have a post and want its media // we have a post and want its media
$first_post = R('first'); $first_post = R('first');
foreach (M($first_post) as $image) { echo EM($image); } foreach (M($first_post) as $image) { echo EM($image); }
</pre>
var_dump(M());
<h2>EM()</h2>
<p>
<code>EM()</code> returns information about a particular attached media.
The typical usage is to get the necessary HTML for embedding the specificed media, but other information can be retrieved:
</p>
<pre class="prettyprint lang-php">
// we're in a Loop, so grab the current post's media and embed it
foreach (M() as $image) {
echo EM($image); // embed code for the default media, &lt;img /&gt; tags for images
echo EM($image, 'archive'); // embed code for the archive media
$attachment = EM($image, null, 'object'); // the ComicPressBackend object for the default image
}
</pre> </pre>

77
docs/en_US/storyline-basics.html Normal file
View File

@ -0,0 +1,77 @@
<h1>Storyline Basics</h1>
<p>
A word before you go any further: For <em>ComicPress Core</em> to work properly, <strong>posts can only be in one category!</strong>
<em>ComicPress Core</em> will reject any post in more than one category. If you want to put your posts in additional taxonomies, <strong>use tags</strong>.
</p>
<h2>Child Category Ordering</h2>
<p>
A <strong>storyline</strong> in <em>ComicPress Core</em> parlance is a set of ordered, structured categories.
By default, categories in WordPress maintain only parent to child relationships &mdash; a category knows if it has a parent, and what that parent is. See the category list below:
</p>
<ul>
<li><strong>My Comics</strong> has no parent. It's at the root of the hierarchy.</li>
<ul>
<li><strong>My Funny Comic</strong> has a parent. It's the <em>My Comics</em> category.</li>
<ul>
<li><strong>Chapter One</strong> has a parent. It's the <em>My Funny Comic</em> category.</li>
</ul>
<li><strong>My Serious Comic</strong> has a parent. It's the <em>My Comics</em> category.</li>
</ul>
</ul>
<p>
While WordPress stores parent/child relationships, it does not store the order of all of the children underneath of a parent (the siblings). It always sorts them alphabetically by name.
This is bad for Websites that want to run structured sequential creative works, as that means you'd have to name your categories in a way that would cause them to sort
alphabetically, making the names nonsensical:
</p>
<ul>
<li><strong>My Comics</strong> will be first, because it has no siblings.</li>
<ul>
<li><strong>01: My Funny Comic</strong> will sort first, because <em>01</em> is less than <em>02</em>.</li>
<ul>
<li><strong>01: Chapter One</strong> will be first, because it has no siblings.</li>
</ul>
<li><strong>02: My Serious Comic</strong> will sort second, because <em>02</em> is greater than <em>01</em>.</li>
</ul>
</ul>
<p>
<em>ComicPress Core</em> allows you to sort your categories in any order, and that order is stored within <em>ComicPress Core</em>'s own configuration.
This would allow you to ensure that <strong>My Funny Comic</strong> always appears before <strong>My Serious Comic</strong>,
no matter how many children <strong>My Comics</strong> has.
</p>
<h2>Extending WordPress to Know About Sort Ordering</h2>
<p>
In order for theme developers to be able to access this sort ordering information, <em>ComicPress Core</em> provides two template tags called <code>SL()</code> and <code>SC()</code>
to retrieve information about the structure of categories. It's a much richer interface than WordPress's provided interface, because they always return hierarchical information:
</p>
<pre class="prettyprint lang-php">
foreach (SL() as $category_id => $info) {
$category = get_category($category_id);
printf('Category %d is %d levels deep', $category->name, $info['level']);
}
// by default, SC() returns categories relative to the current post
$next = SC('next');
$previous = SC('previous');
$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');
</pre>
<h2>Finding and Using Posts</h2>
<p>
Since <em>ComicPress Core</em> knows about the structure of your storyline, you can use <em>ComicPress Core</em>'s advanced post search template tags to search subsets of your categories.
This is where a cool interactive goes that illustrates this complex process.
</p>

28
docs/en_US/storyline-post-template-tags.html
View File

@ -1,8 +1,8 @@
<h1>Storyline Post Template Tags</h1> <h1>Storyline Post Template Tags</h1>
<p> <p>
<em>ComicPress Core</em> provides a number of functions that allow you to traverse the storyline structure created from your blog's categories. <em>ComicPress Core</em> 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 <code>functions.inc</code> file within your <em>ComicPress Core</em> installation. Technical details about these template tags can be found in the <code>functions.inc</code> file within your <em>ComicPress Core</em> installation.
</p> </p>
<h2>R() and RT()</h2> <h2>R() and RT()</h2>
@ -240,27 +240,3 @@ if (apply_filters('comicpress-RT', 'last', array('child_of' => 'comic'))) {
do_action('comicpress-Unprotect'); do_action('comicpress-Unprotect');
</pre> </pre>
<h2>SL() and SC()</h2>
<p>
<code>SL()</code> and <code>SC()</code> give you access to the current storyline category information.
<code>SL()</code> lists all of the categories, in order, with the necessary metadata to traverse and understand the structure.
<code>SC()</code> lets you quickly traverse the storyline, returning category objects as it goes.
</p>
<pre class="prettyprint lang-php">
foreach (SL() as $category_id => $info) {
$category = get_category($category_id);
printf('Category %d is %d levels deep', $category->name, $info['level']);
}
// by default, SC() returns categories relative to the current post
$next = SC('next');
$previous = SC('previous');
$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');
</pre>

31
docs/en_US/storyline-traversal.html Normal file
View File

@ -0,0 +1,31 @@
<h1>Storyline Traversal Template Tags</h1>
<p>
<em>ComicPress Core</em> provides functions for traversing the storyline categories themselves.
These are used to find the adjacent (previous, next, parent) categories of a particular category, and to
find how deep in the hierarchy a category is located.
</p>
<h2>SL() and SC()</h2>
<p>
<code>SL()</code> and <code>SC()</code> give you access to the current storyline category information.
<code>SL()</code> lists all of the categories, in order, with the necessary metadata to traverse and understand the structure.
<code>SC()</code> lets you quickly traverse the storyline, returning category objects as it goes.
</p>
<pre class="prettyprint lang-php">
foreach (SL() as $category_id => $info) {
$category = get_category($category_id);
printf('Category %d is %d levels deep', $category->name, $info['level']);
}
// by default, SC() returns categories relative to the current post
$next = SC('next');
$previous = SC('previous');
$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');
</pre>