crowdfavorite / wp-threads

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

=== Plugin Name ===
Contributors: alexkingorg, crowdfavorite
Tags: content, timeline, display, presentation, story, storyline, context
Requires at least: 3.5
Tested up to: 3.5.1
Stable tag: 1.0b1
License: GPLv2
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Threads displays a timeline of related posts.

== Description ==

If you have ongoing themes you write about on your site, you can use Threads to show those posts in a timeline, with a link to the timeline from each of the posts. This helps you avoid feeling like you have to rehash too much history about the topic in each post.

Another good usage of Threads is on a news site to track posts related to a single ongoing story. For example, a tech blog might create a thread to group stories about a product launch event. Several months later, stories about sales figures for the product might be added to the thread. By placing all of these posts in a thread, there is a useful visual way of browsing all of the posts.

The timeline display of a thread is both responsive and retina (HiDPI) friendly. See an <a href="http://alexking.org/blog/thread/content">example here</a>.

Developers, please contribute on <a href="https://github.com/crowdfavorite/wp-threads">GitHub</a>.

== Installation ==

1. Upload the `threads` directory to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Optional: add the Recent Threads widget to your sidebar
1. Optional: use the shortcode to display a thread timeline in a post or page

Shortcode syntax:

`[thread term="thread-slug"]`

== Frequently Asked Questions ==

= What is the time threshold for "collapsing" a longer time period to be shown as a break in the timeline? =

3 months. In our testing, we found that any distance longer than 250 pixels or so seemed like too much. This is our current approach to that situation.

= What themes is Threads compatible with? =

Threads has been tested with <a href="http://crowdfavorite.com/wordpress/themes/favepersonal/">FavePersonal</a>, Twenty Ten, Twenty Eleven, Twenty Twelve and Twenty Thirteen (beta). We hope it will be compatible with most themes, but cannot guarantee compatibility with any specific theme.

= How can I list my posts from newest to oldest instead of vice versa? =

You can override the thread view to create any presentation you like. You can also adjust how the timeline posts are retrieved using the `threads_timeline_posts_query` filter.

= How can I show posts from a thread in a different way? =

If you want to use different images, you can use the filters to use your own. Example, changing the background for the "long time break":

	function my_custom_background($url, $path, $plugin_file_path) {
		// check for the file we want to change
		if ($path == 'img/lat.png') [
			// change it to the full HTTP path we want to use
			$path = 'http://example.com/path/to/your/background.png');
		}
		return $path;
	}
	add_filter('cfth_asset_url', 'my_custom_background', 10, 3);

If you want to output different CSS, that's easy as well. Example:

	function my_custom_css($my_css) {
		$my_css = '<style>
			.threads-timeline {
				/* your CSS rules here */
			}
			/* ... */
		</style>';
		return $css;
	}
	add_filter('threads_timeline_css', 'my_custom_css');

This utilizes the <a href="http://codex.wordpress.org/Plugin_API">WordPress Plugin API</a> - it's how to customize something without having to hack the code (and lose your changes on upgrade).

If you want to do a completely different presentation of your thread, that's straightforward too. The thread is connected by a custom taxonomy term - you can query on this term to get the posts and present them any way you like.

If you don't want to write your own code, you may find that a plugin like <a href="http://wordpress.org/extend/plugins/query-posts/">Query Posts</a> is a good solution for you.

= Why isn't my question listed here? =

Ask them in the support forums and we'll add them here as they are answered.

== Screenshots ==

1. The timeline for a thread.
2. Notice that a post is part of a thread.
3. Editing a thread post.

== Changelog ==

= 1.0b1 =
* Initial public release.

== Upgrade Notice ==

= 1.0b1 =
Initial public release.

== Developers ==

The architecture of Threads is a custom taxonomy coupled with a "dependent" custom post type where content (description, featured image, etc.) for the taxonomy term can be stored. The <a href="https://github.com/crowdfavorite/wp-tax-post-binding">CF Taxonomy Post Type Binding</a> plugin provides the functionality to keep the post type and taxonomy term in sync with each other. The thread display is the display of the custom post type, while the taxonomy is not public.

Threads separates presentation files into views, with appropriate <a href="http://codex.wordpress.org/Plugin_API">filters</a> on each. You can override the templates, CSS, etc. used to display a thread timeline by using these filters.

Developement for Threads occurs in the <a href="https://github.com/crowdfavorite/wp-threads">public GitHub repository</a>, please collaborate with us there.

About


Languages

Language:PHP 100.0%