Welcome to Miniblog! Make sure you have the latest version, or it may not work with your version of WordPress. The latest version can be found at the following URL: http://blog.fileville.net/?page_id=121. This plugin was orignally written by Ryan Poe. Development and support was taken over by Thomas Cort in July 2005 and now is being developed by Joe.

Miniblog is a plugin for Wordpress 1.5 and 2.0. It is:

Help on adding items to, editing, or deleting items from the database.

The Title is simply the title of the item you wish to post.

This field is designated as a URL for link blogging, but it can be used for any purpose, as it is not required to input a hyperlink.

This field may not seem self explanatory at first, but it's really just a way to organize one's postings. The default entry is "default," so if one never changed the field, all posts would fall under this one category.

An example use of this is to separate your link blog from your asides. For every link blog entry made, one would change this field to "link." For every aside entry made, one would change this field to "aside." This is done so that they can later be called separately in templates.

This field doesn't appear the first time you publish an entry. To get it, you must save the entry and edit it via the list. All it does is allow you to change the date or time of the post. The format is Year-Month-Day Hour:Minute:Second (military time).

This field is the content of the entry. It is passed through the_content's filters.

Miniblog allows you to display part of a post with a "read on" link that links to the rest of the post. To use this feature you must do two things. First, when you use functions like miniblog_list_entries(...) or miniblog_return_entries(...) you must set the full parameter to 0. This enables the "read on" feature. Second, just put "[readon]" (without quotes) in the text of your post where you want the "read on" link to appear.

This section demonstrates how one can use the entries saved in their templates.

This function is a beginner friendly version of miniblog_return_entries(). It has default formatting that is changeable and tries to keep in cahoots with other WordPress list functions.

The function is designed to be smart. If you have no title or url, it displays the date. If you have a title and no URL, it displays the title with no link. If you have a URL and no title, it uses the date as the href title. If you have no entry text, it skips the between parameter and displays nothing as a description.

Parameters:

  1. Before: text to display before every entry's title link. Default is '<li>'.
  2. Between: text to display between every entry's title link and text. Default is '<br />'. To make the entry text appear on the same line as the title, set this parameter to '<none>'.
  3. After: text to display after every entry's text. Default is '</li>'.
  4. Blog Identifier: this determines which entries to call specified by an entry's "Blog Identifier" field. This can be any text string. To retrieve all field, leave blank (''). Default is blank ('').
  5. Limit: the number of entries to return. Default is 10.
  6. Offset: the number of entries to skip before returning. For instance, a limit of 5 with an offset of 5 will return entries 6 through 10. Default is 0.
  7. Sort Field: this is the field that determines the order in which entries are returned. Prepending an underscore (_) to the parameter sorts the entries descending (latest first) as opposed to ascending (earliest first).

    Options:

    • ID - an entry's ID (unique).
    • Date - the date the entry was posted.
    • Blog - the entry's blog identifier field.
    • Title - the entry's title.
    • URL - the entry's URL.
    • Text - the entry's text.
    Default is '_date.'

  8. Filter Text: this boolean option determines rather or not to filter the entry's text through the_content's filters. This is useful to set to false if you want to use ad plugins that apply a filter to the_content to show relevant ads. Default is FALSE.
  9. Full: this option determines if the full text of posts should be displayed regardless of [readon] tags, or if posts should be truncated at the [readon] tag. Default is 1 for use full text (ie ignore [readon] tags in posts). Set it to 0 to enable the "read on" feature.

Examples:

<h2>Asides</h2>
<ul>
    <?php miniblog_list_entries(); ?>
</ul>

This will output the latest 5 entries in a simple list that makes up of only the title and the text separated with a line break.

<h2>Asides</h2>
<
ul>
    
<?php miniblog_list_entries('<li><strong>', '</strong><blockquote>', '</blockquote></li>', 'aside', 10); ?>
</
ul>

This will output the latest 10 entries with the blog identifier of 'aside' and display them in a list that will resemble this:

This function returns a set of entries into an array of arrays containing entry data.

Parameters:

  1. Limit: the number of entries to return. Default is 10.
  2. Offset: the number of entries to skip before returning. For instance, a limit of 5 with an offset of 5 will return entries 6 through 10. Default is 0.
  3. Blog Identifier: this determines which entries to call specificied by an entry's "Blog Identifier" field. This can be any text string. To retrieve all field, leave blank (''). Default is blank ('').
  4. Sort Field: this is the field that determines the order in which entries are returned. Prepending an underscore (_) to the parameter sorts the entries descending (latest first) as opposed to ascending (earliest first).

    Options:

    • ID - an entry's ID (unique).
    • Date - the date the entry was posted.
    • Blog - the entry's blog identifier field.
    • Title - the entry's title.
    • URL - the entry's URL.
    • Text - the entry's text.
    Default is '_date.'

  5. Filter Text: this boolean option determines rather or not to filter the entry's text through the_content's filters. This is useful to set to false if you want to use ad plugins that apply a filter to the_content to show relevant ads. Default is FALSE.
  6. Full: this option determines if the full text of posts should be displayed regardless of [readon] tags, or if posts should be truncated at the [readon] tag. Default is 1 for use full text (ie ignore [readon] tags in posts). Set it to 0 to enable the "read on" feature.

The array for each entry contains an object that can be accessed by calling the following methods.

Examples:

<?php
    $asides
= miniblog_return_entries(5, 0, '', 'Title');
    foreach(
$asides as $aside) { ?>
        <li><?php _e($aside->title); ?><br /><?php _e($aside->text); ?></li>
<?php } ?>

This will output the latest 5 entries in a simple list that makes up of only the title and the text separated with a line break.

<?php
    $news_array
= miniblog_return_entries(15, 0, 'news', '_date');
    if(
$news_array) {
        foreach(
$news_array as $news) { ?>
            <div class="post">
                <h2>
                    <a href="<?php _e($news->url); ?>">
                     <?php _e($news->title); ?>
                    </a>
                </h2>
                <div class="meta">
                    Posted on <?php _e(date("F j, Y, g:i a", strtotime($news->date))); ?>
                </div>
                <div class="content">
                    <?php _e($news->text); ?>
                </div>
            </div>
        <? }
    }
?>

This will output the latest 15 entries with the string 'news' in their blog identifier field and outputs them in a format much like Wordpress's default output style.

This function returns a URL to an RSS 2.0 feed specified by the parameters entered. Miniblog also supports RSS 0.92. To return a URL to an RSS 0.92 feed you must specify a version parameter of 0.92. The parameters for miniblog_create_rss_url() are exactly the same as the parameters of miniblog_return_entries() with a few note-worthy exceptions:

  1. Limit: the number of entries to return. Default is 10.
  2. Offset: the number of entries to skip before returning. For instance, a limit of 5 with an offset of 5 will return entries 6 through 10. Default is 0.
  3. Blog Identifier: this determines which entries to call specificied by an entry's "Blog Identifier" field. This can be any text string. To retrieve all field, leave blank (''). Default is blank ('').
  4. Sort Field: this is the field that determines the order in which entries are returned. Prepending an underscore (_) to the parameter sorts the entries descending (latest first) as opposed to ascending (earliest first).
  5. RSS Feed Title: this field determines the title of the RSS feed. Default is %site_name%.
  6. RSS Feed Description: this field determines the description of the RSS feed. Default is %site_description%.
  7. Version: this field determines which RSS version to use. 2.0 and 0.92 are supported. Default is 2.0.

Fields 5 and 6 can have the following template tags within them:

Examples:

<a href="<?php _e(miniblog_create_rss_url()); ?>">Miniblog RSS 2.0</a>

<a href="<?php _e(miniblog_create_rss_url(5, 0, 'aside', '_date', "%site_name%'s Asides", "%site_name% (%site_description%) has asides. These are them.", 0.92)); ?>">Miniblog RSS 0.92</a>

This example will output an RSS feed link with the title of "Mosltynothings's asides" and a description of "FileVille Blog" (Just another WordPress blog) has asides. These are them." The RSS feed will be RSS v0.92 compliant. Your blog will show different results (because your blog has different settings).

This function returns a URL to an archive of posts specified by the parameters entered. The parameters for miniblog_create_archive_url() are similar to the parameters of miniblog_create_rss_url() with a few note-worthy exceptions:

  1. Limit: the number of entries to return. Default is 10.
  2. Offset: the number of entries to skip before returning. For instance, a limit of 5 with an offset of 5 will return entries 6 through 10. Default is 0.
  3. Blog Identifier: this determines which entries to call specificied by an entry's "Blog Identifier" field. This can be any text string. To retrieve all field, leave blank (''). Default is blank ('').
  4. Sort Field: this is the field that determines the order in which entries are returned. Prepending an underscore (_) to the parameter sorts the entries descending (latest first) as opposed to ascending (earliest first).
  5. Title: this is the field that determines the title to use on the archive page. Default is Miniblog Archive.
  6. Before: text to display before every entry's title link. Default is '<li>'.
  7. Between: text to display between every entry's title link and text. Default is '<br />'.
  8. After: text to display after every entry's text. Default is '</li>'.
  9. Full: this option determines if the full text of posts should be displayed regardless of [readon] tags, or if posts should be truncated at the [readon] tag. Default is 1 for use full text (ie ignore [readon] tags in posts). Set it to 0 to enable the "read on" feature.

Examples:

<a href="<?php _e(miniblog_create_archive_url()); ?>">Miniblog Archive</a>

<a href="<?php _e(miniblog_create_archive_url(5, 0, 'aside', '_date', 'Asides Archive')); ?>">Asides Archive</a>

<a href="<?php _e(miniblog_create_archive_url(5, 0, 'aside', '_date', 'Asides Archive', '<li>', '<br />', '</li>')); ?>">Asides Archive</a>

This function returns a URL to a single post specified by the postid parameter. See the "Post List" at the top of the page for a list of ID numbers.

  1. ID: The post ID number.

Example:

<a href="<?php _e(miniblog_create_post_url(22)); ?>">My Post About Cheese</a>