/code/cake/app/webroot/cp/wp-content/plugins/commentpress-core/commentpress-core/class_commentpress_display.php

Large files files are truncated, but you can click here to view the full file

<?php /*
================================================================================
Class CommentpressCoreDisplay
================================================================================
AUTHOR: Christian Wach <needle@haystack.co.uk>
--------------------------------------------------------------------------------
NOTES
=====



--------------------------------------------------------------------------------
*/






/*
================================================================================
Class Name
================================================================================
*/

class CommentpressCoreDisplay {






	/*
	============================================================================
	Properties
	============================================================================
	*/
	
	// parent object reference
	var $parent_obj;
	
	// database object
	var $db;
	






	/** 
	 * @description: initialises this object
	 * @param object $parent_obj a reference to the parent object
	 * @return object
	 * @todo: 
	 *
	 */
	function __construct( $parent_obj ) {
	
		// store reference to parent
		$this->parent_obj = $parent_obj;
	
		// store reference to database wrapper (child of calling obj)
		$this->db = $this->parent_obj->db;
	
		// init
		$this->_init();

		// --<
		return $this;

	}






	/**
	 * @description: PHP 4 constructor
	 */
	function CommentpressCoreDisplay( $parent_obj ) {
		
		// is this php5?
		if ( version_compare( PHP_VERSION, "5.0.0", "<" ) ) {
		
			// call php5 constructor
			$this->__construct( $parent_obj );
			
		}
		
		// --<
		return $this;

	}






	/** 
	 * @description: if needed, sets up this object
	 * @todo: work out how to upgrade.
	 *
	 */
	function activate() {
		
		// force WordPress to regenerate theme directories
		search_theme_directories( true );
		
		
		
		// get groupblog-set theme, if we have one
		$theme = $this->parent_obj->get_groupblog_theme();
		
		// did we get a CommentPress Core one?
		if ( $theme !== false ) {
			
			// we're in a groupblog context: BP Groupblog will already have set
			// the theme because we're adding our wpmu_new_blog action after it
			
			// --<
			return; 
			
		}
		
		
		
		// test for WP3.4...
		if ( function_exists( 'wp_get_themes' ) ) {
		
			// get CommentPress Core theme by default, but allow overrides
			$target_theme = apply_filters(
				'cp_forced_theme_slug',
				'commentpress-theme'
			);
			
			// get the theme we want
			$theme = wp_get_theme( 
				
				$target_theme
				
			);
			
			// if we get it...
			if ( $theme->exists() ) {
				
				// ignore if not allowed
				//if ( is_multisite() AND !$theme->is_allowed() ) { return; }
				
				// activate it
				switch_theme( 
					$theme->get_template(), 
					$theme->get_stylesheet() 
				);
				
			}

		} else {
			
			// use pre-3.4 logic
			$themes = get_themes();
			//print_r( $themes ); die();
		
			// get CommentPress Core theme by default, but allow overrides
			// NB, the key prior to WP 3.4 is the theme's *name*
			$target_theme = apply_filters(
				'cp_forced_theme_name',
				'CommentPress Default Theme'
			);
			
			// the key is the theme name
			if ( isset( $themes[ $target_theme ] ) ) {
				
				// activate it
				switch_theme(
					$themes[ $target_theme ]['Template'], 
					$themes[ $target_theme ]['Stylesheet'] 
				);
		
			}
			
		}

	}







	/** 
	 * @description: if needed, destroys this object
	 * @todo: 
	 *
	 */
	function deactivate() {
	
		// test for WP3.4...
		if ( function_exists( 'wp_get_theme' ) ) {
		
			// get CommentPress Core theme by default, but allow overrides
			$target_theme = apply_filters(
				'cp_restore_theme_slug',
				WP_DEFAULT_THEME
			);
			
			// get the theme we want
			$theme = wp_get_theme( 
				
				$target_theme
				
			);
			
			// if we get it...
			if ( $theme->exists() ) {
				
				// ignore if not allowed
				//if ( is_multisite() AND !$theme->is_allowed() ) { return; }
				
				// activate it
				switch_theme( 
					$theme->get_template(), 
					$theme->get_stylesheet() 
				);
				
			}

		} else {
			
			// use pre-3.4 logic
			$themes = get_themes();
			//print_r( $themes ); die();
		
			// get default theme by default, but allow overrides
			// NB, the key prior to WP 3.4 is the theme's *name*
			$target_theme = apply_filters(
				'cp_restore_theme_name',
				WP_DEFAULT_THEME
			);
			
			// the key is the theme name
			if ( isset( $themes[ $target_theme ] ) ) {
				
				// activate it
				switch_theme(
					$themes[ $target_theme ]['Template'], 
					$themes[ $target_theme ]['Stylesheet'] 
				);
		
			}
			
		}

	}







//##############################################################################







	/*
	============================================================================
	PUBLIC METHODS
	============================================================================
	*/
	




	/** 
	 * @description: enqueue jQuery, jQuery UI and plugins
	 * @todo: 
	 *
	 */
	function get_jquery() {
	
		// default to minified scripts
		$debug_state = '';
	
		// target different scripts when debugging
		if ( defined( 'SCRIPT_DEBUG' ) AND SCRIPT_DEBUG === true ) {
		
			// use uncompressed scripts
			$debug_state = '.dev';
		
		}
		
		
		
		// add our javascript plugin and dependencies
		wp_enqueue_script(
		
			'jquery_commentpress', 
			plugins_url( 'commentpress-core/assets/js/jquery.commentpress'.$debug_state.'.js', COMMENTPRESS_PLUGIN_FILE ),
			array( 'jquery', 'jquery-form', 'jquery-ui-core', 'jquery-ui-resizable' ),
			COMMENTPRESS_VERSION // version
		
		);
		
		// add jQuery Scroll-To plugin
		wp_enqueue_script( 
			
			'jquery_scrollto', 
			plugins_url( 'commentpress-core/assets/js/jquery.scrollTo.js', COMMENTPRESS_PLUGIN_FILE ),
			array( 'jquery_commentpress' ),
			COMMENTPRESS_VERSION // version
		
		);
		
		// add jQuery Cookie plugin (renamed to jquery.biscuit.js because some hosts don't like 'cookie' in the filename)
		wp_enqueue_script( 
		
			'jquery_cookie', 
			plugins_url( 'commentpress-core/assets/js/jquery.biscuit.js', COMMENTPRESS_PLUGIN_FILE ),
			array( 'jquery_commentpress' ),
			COMMENTPRESS_VERSION // version
			
		);
		
		/*
		Prior to WP3.2 (IIRC), jQuery UI has to be added separately, as the built in one was not 
		sufficiently up-to-date. This is no longer the case, so the independent jQuery UI package 
		has been removed from CommentPress Core in favour of the built-in one.
		*/

	}
	
	
	
	
	


	/** 
	 * @description: enqueue our quicktags script
	 * @todo: 
	 *
	 */
	function get_custom_quicktags() {
	
		// don't bother if the current user lacks permissions
		if ( ! current_user_can('edit_posts') AND ! current_user_can('edit_pages') ) {
			return;
		}
		
		// need access to WP version
		global $wp_version;
	
		// there's a new quicktags script in 3.3
		if ( version_compare( $wp_version, '3.2.99999', '>=' ) ) {
		
			// add our javascript script and dependencies
			wp_enqueue_script(
			
				'commentpress_custom_quicktags',
				plugin_dir_url( COMMENTPRESS_PLUGIN_FILE ) . 'commentpress-core/assets/js/cp_quicktags_3.3.js',
				array( 'quicktags' ),
				COMMENTPRESS_VERSION, // version
				true // in footer
				
			);
			
		} else {
		
			// add our javascript script and dependencies
			wp_enqueue_script(
			
				'commentpress_custom_quicktags',
				plugin_dir_url( COMMENTPRESS_PLUGIN_FILE ) . 'commentpress-core/assets/js/cp_quicktags.js',
				array( 'quicktags' ),
				COMMENTPRESS_VERSION, // version
				false // not in footer (but may need to be in WP 3.3)
				
			);
			
		}

	}
	
	
	
	
	


	/** 
	 * @description: get plugin stylesheets
	 * @return string $styles
	 * @todo: 
	 *
	 */
	function get_frontend_styles() {
		
		// add jQuery UI stylesheet -> needed for resizable columns
		wp_enqueue_style(
		
			'cp_jquery_ui_base', 
			plugins_url( 'commentpress-core/assets/css/jquery.ui.css', COMMENTPRESS_PLUGIN_FILE ),
			false,
			COMMENTPRESS_VERSION, // version
			'all' // media
			
		);
		
	}
	
	
	
	


	/** 
	 * @description: test if TinyMCE is allowed
	 * @return boolean $allowed
	 * @todo: 
	 *
	 */
	function is_tinymce_allowed() {
	
		// check option
		if ( 
		
			$this->db->option_exists( 'cp_comment_editor' ) AND
			$this->db->option_get( 'cp_comment_editor' ) != '1'
			
		) {
		
			// --<
			return false;
		
		}
		
		
		
		// don't return TinyMCE for touchscreens, mobile phones or tablets
		if ( $this->db->is_mobile_touch OR $this->db->is_mobile OR $this->db->is_tablet ) {
		
			// --<
			return false;
		
		}
		
		
		
		// --<
		return true;
		
	}
	
	
	
		
		
		
	/** 
	 * @description: get built-in TinyMCE scripts from Wordpress Includes directory
	 * @return string $scripts
	 * @todo: 
	 *
	 */
	function get_tinymce() {
	
		// check if we can
		if ( !$this->is_tinymce_allowed() ) {
		
			// --<
			return;
		
		}
		
		
		
		// test for wp_editor()
		if ( function_exists( 'wp_editor' ) ) {
		
			// don't include anything - this will be done in the comment form template
			return;
			
		} else {
		
			// test for WordPress version
			global $wp_version;
			
			// for WP 3.2+
			if ( version_compare( $wp_version, '3.2', '>=' ) ) {
				
				// don't need settings
				$this->_get_tinymce();
			
			} else {
			
				// get site HTTP root
				$site_http_root = trailingslashit( get_bloginfo('wpurl') );
		
				// all TinyMCE scripts
				$scripts .= '<!-- TinyMCE -->
<script type="text/javascript" src="'.$site_http_root.'wp-includes/js/tinymce/tiny_mce.js"></script>
<script type="text/javascript" src="'.$site_http_root.'wp-includes/js/tinymce/langs/wp-langs-en.js?ver=20081129"></script>
'."\n";

				// add our init
				$scripts .= $this->_get_tinymce_init();
				
				// out to browser
				echo $scripts;
				
			}
			
		}

	}
	
	
	
	
	


	/** 
	 * @description: get help text
	 * @return HTML $help
	 * @todo: translation
	 *
	 */
	function get_help() {
	
		$help = <<<HELPTEXT
<p>For further information about using CommentPress, please refer to the <a href="http://www.futureofthebook.org/commentpress/support/">CommentPress support pages</a> or use one of the links below:</p>

<ul>
<li><a href="http://www.futureofthebook.org/commentpress/support/structuring-your-document/">Structuring your Document</a></li>
<li><a href="http://www.futureofthebook.org/commentpress/support/formatting-your-document/">Formatting Your Document</a></li>
<li><a href="http://www.futureofthebook.org/commentpress/support/using-commentpress/">How to read a CommentPress document</a></li>
</ul>
HELPTEXT;

		// --<
		return $help;

	}
	
	
	
	
	
	


	/** 
	 * @description: show the posts and their comment count in a list format
	 * @todo:
	 *
	 */
	function list_posts( $params = 'numberposts=-1&order=DESC' ) {
	
		// get all posts
		$posts = get_posts( $params );
		
		// have we set the option?
		$list_style = $this->db->option_get( 'cp_show_extended_toc' );
		//print_r( $list_style ); die();
		
		// if not set or set to 'off'
		if ( $list_style === false OR $list_style == '0' ) {
		
			// --------------------------
			// old-style undecorated list
			// --------------------------
		
			// run through them...
			foreach( $posts AS $item ) {
		
				// get comment count for that post
				$count = count( $this->db->get_approved_comments( $item->ID ) );
		
				// write list item
				echo '<li class="title"><a href="'.get_permalink( $item->ID ).'">'.get_the_title( $item->ID ).' ('.$count.')</a></li>'."\n";
			
			}
			
		} else {
	
			// ------------------------
			// new-style decorated list
			// ------------------------
		
			// run through them...
			foreach( $posts AS $item ) {
			
				// init output
				$_html = '';
			
				//print_r( $item ); die();
				//setup_postdata( $item );
		
				// get comment count for that post
				$count = count( $this->db->get_approved_comments( $item->ID ) );
				
				// compat with Co-Authors Plus
				if ( function_exists( 'get_coauthors' ) ) {
				
					// get multiple authors
					$authors = get_coauthors( $item->ID );
					//print_r( $authors ); die();
					
					// if we get some
					if ( !empty( $authors ) ) {
					
						// use the Co-Authors format of "name, name, name & name"
						$author_html = '';
						
						// init counter
						$n = 1;
						
						// find out how many author we have
						$author_count = count( $authors );
					
						// loop
						foreach( $authors AS $author ) {
							
							// default to comma
							$sep = ', ';
							
							// if we're on the penultimate
							if ( $n == ($author_count - 1) ) {
							
								// use ampersand
								$sep = __( ' &amp; ', 'commentpress-core' );
								
							}
							
							// if we're on the last, don't add
							if ( $n == $author_count ) { $sep = ''; }
							
							// get name
							$author_html .= $this->echo_post_author( $author->ID, false );
							
							// and separator
							$author_html .= $sep;
							
							// increment
							$n++;
							
							// are we showing avatars?
							if ( get_option( 'show_avatars' ) ) {
							
								// get avatar
								$_html .= get_avatar( $author->ID, $size='32' );
								
							}
								
						}
						
						// add citation
						$_html .= '<cite class="fn">'.$author_html.'</cite>'."\n";
						
						// add permalink
						$_html .= '<p class="post_activity_date">'.get_the_time('l, F jS, Y', $item->ID).'</p>'."\n";
							
					}
				
				} else {
				
					// get avatar
					$author_id = $item->post_author;

					// are we showing avatars?
					if ( get_option( 'show_avatars' ) ) {
					
						$_html .= get_avatar( $author_id, $size='32' );
						
					}
					
					// add citation
					$_html .= '<cite class="fn">'.$this->echo_post_author( $author_id, false ).'</cite>';
					
					// add permalink
					$_html .= '<p class="post_activity_date">'.get_the_time('l, F jS, Y', $item->ID).'</p>';
					
				}
					
				// write list item
				echo '<li class="title">
				<div class="post-identifier">
				'.$_html.'
				</div>
				<a href="'.get_permalink( $item->ID ).'" class="post_activity_link">'.get_the_title( $item->ID ).' ('.$count.')</a>
				</li>'."\n";
			
			}
		
		}
		
	}
	
	
	
	
	
	
	
	/** 
	 * @description: show username (with link)
	 * @todo: remove from theme functions.php?
	 *
	 */
	function echo_post_author( $author_id, $echo = true ) {
	
		// get author details
		$user = get_userdata( $author_id );
		
		// kick out if we don't have a user with that ID
		if ( !is_object( $user ) ) { return; }
		
		
		
		// access plugin
		global $commentpress_core, $post;
	
		// if we have the plugin enabled and it's BP
		if ( is_object( $post ) AND is_object( $commentpress_core ) AND $commentpress_core->is_buddypress() ) {
		
			// construct user link
			$author = bp_core_get_userlink( $user->ID );
	
		} else {
		
			// link to theme's author page
			$link = sprintf(
				'%1$s',
				esc_html( $user->display_name )
			);
			$author = apply_filters( 'the_author_posts_link', $link );
	
		}
		
		// if we're echoing
		if ( $echo ) { 
			echo $author;
		} else {
			return $author;
		}
			
	}
	
	
	
	
	
	
	/** 
	 * @description: print the posts and their comment count in a list format
	 * @todo:
	 *
	 */
	function list_pages() {
	
		/* 
		Question: do we want to use WP menus? And if so, how?
		
		Currently, we're using wp_list_pages(), so let's try wp_page_menu() first
		
		
		
		// If we set the theme to use wp_nav_menu(), we need to register it
		register_nav_menu( 'primary', __( 'Primary Menu', 'commentpress-core' ) );
	
		Our navigation menu. If one isn't filled out, wp_nav_menu falls back to 
		wp_page_menu. The menu assiged to the primary position is the one used. If 
		none is assigned, the menu with the lowest ID is used. 

		//wp_nav_menu( array( 'theme_location' => 'primary' ) );
		
		// set list pages defaults
		$args = array(

			'sort_column' => 'menu_order, post_title',
			'menu_class' => 'menu',
			'include' => '',
			'exclude' => '',
			'echo' => true,
			'show_home' => false,
			'link_before' => '',
			'link_after' => ''

		);
		*/
		
		
		
		// test for custom menu
		if ( has_nav_menu( 'toc' ) ) {
		
			// try and use it
			wp_nav_menu( array( 
				
				'theme_location' => 'toc',
				'echo' => true,
				'container' => '',
				'items_wrap' => '%3$s',
				
			) );
			
			return;
		
		}
		
		
		
		// get welcome page ID
		$welcome_id = $this->db->option_get( 'cp_welcome_page' );
		
		// get front page
		$page_on_front = $this->db->option_wp_get( 'page_on_front' );
		
		// print link to title page, if we have one and it's the front page
		if ( $welcome_id !== false AND $page_on_front == $welcome_id ) {
		
			// define title page
			$title_page_title = get_the_title( $welcome_id );
		
			// allow overrides
			$title_page_title = apply_filters( 'cp_title_page_title', $title_page_title );
		
			// echo list item
			echo '<li class="page_item page-item-'.$welcome_id.'"><a href="'.get_permalink( $welcome_id ).'">'.$title_page_title.'</a></li>';
		
		}
		


		// get page display option
		//$depth = $this->db->option_get( 'cp_show_subpages' );
		
		// ALWAYS write subpages into page, even if they aren't displayed
		$depth = 0;
		
		

		// get pages to exclude
		$exclude = $this->db->option_get( 'cp_special_pages' );
		
		// do we have any?
		if ( !$exclude ) { $exclude = array(); }
		
		// exclude title page, if we have one
		if ( $welcome_id !== false ) { $exclude[] = $welcome_id; }


		// set list pages defaults
		$defaults = array(
		
			'depth' => $depth,
			'show_date' => '',
			'date_format' => $this->db->option_get( 'date_format' ),
			'child_of' => 0,
			'exclude' => implode( ',', $exclude ),
			'title_li' => '',
			'echo' => 1,
			'authors' => '',
			'sort_column' => 'menu_order, post_title',
			'link_before' => '',
			'link_after' => '',
			'exclude_tree' => ''
		
		);
		
		// use Wordpress function to echo
		wp_list_pages( $defaults );


		
		
		/*
		
		// The following code manually lists pages, but adds the comment count to the name
		
		// init params
		$params = 'sort_column=menu_order';
		
		// exclude the special pages
		$params .= '&exclude='.implode( ',', $special );
		
		//echo $params; exit();
	
		// get all pages
		$_pages = get_pages( $params );
		
		// run through them...
		foreach( $_pages AS $_page ) {
	
			// get comment count for that page
			$count = count( $this->db->get_approved_comments( $_page->ID ) );
	
			// write list item
			echo '<li class="title"><a href="'.get_page_link( $_page->ID ).'">'.$_page->post_title.' ('.$count.')</a></li>'."\n";
		
		}
		*/

	}
	
	
	
	
	
	
	
	/** 
	 * @description: get the block comment icon
	 * @param integer $comment_count number of comments
	 * @param string $text_signature comment text signature
	 * @param string $block_type either 'auto', 'line' or 'block'
	 * @param integer $para_num sequnetial commentable block number
	 * @return string $comment_icon
	 * @todo: 
	 *
	 */
	function get_comment_icon(
		
		$comment_count, 
		$text_signature, 
		$block_type = 'auto', 
		$para_num = 1 
		
	) { // -->
	
		// reset icon
		$icon = null;

		// if we have no comments...
		if( $comment_count == 0 ) {
			
			// show add comment icon
			$icon = 'comment_add.png';
			$class = ' no_comments';
			
		} elseif( $comment_count > 0 ) {
		
			// show comments present icon
			$icon = 'comment.png';
			$class = ' has_comments';
			
		}
		
		// define block title by block type
		switch ( $block_type ) {
			
			// ----------------------------
			// auto-formatted
			// ----------------------------
			case 'auto':
			default:

				// define title text
				$title_text = sprintf( _n(
					
					// singular
					'There is %d comment written for this paragraph', 
					
					// plural
					'There are %d comments written for this paragraph', 
					
					// number
					$comment_count, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $comment_count );
				
				// define add comment text
				$add_text = sprintf( _n(
					
					// singular
					'Leave a comment on paragraph %d', 
					
					// plural
					'Leave a comment on paragraph %d', 
					
					// number
					$para_num, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $para_num );
				
				break;
			
			// ----------------------------
			// line-by-line, eg poetry
			// ----------------------------
			case 'line':

				// define title text
				$title_text = sprintf( _n(
					
					// singular
					'There is %d comment written for this line', 
					
					// plural
					'There are %d comments written for this line', 
					
					// number
					$comment_count, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $comment_count );
				
				// define add comment text
				$add_text = sprintf( _n(
					
					// singular
					'Leave a comment on line %d', 
					
					// plural
					'Leave a comment on line %d', 
					
					// number
					$para_num, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $para_num );
				
				break;
			

			// ----------------------------
			// comment-blocks
			// ----------------------------
			case 'block':

				// define title text
				$title_text = sprintf( _n(
					
					// singular
					'There is %d comment written for this block', 
					
					// plural
					'There are %d comments written for this block', 
					
					// number
					$comment_count, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $comment_count );
				
				// define add comment text
				$add_text = sprintf( _n(
					
					// singular
					'Leave a comment on block %d', 
					
					// plural
					'Leave a comment on block %d', 
					
					// number
					$para_num, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $para_num );
				
				break;
		
		}
		
		// define small
		$small = '<small class="comment_count" title="'.$title_text.'">'.(string) $comment_count.'</small>';
		
		// define HTML for comment icon
		$comment_icon = '<span class="commenticonbox"><a class="para_permalink'.$class.'" href="#'.$text_signature.'" title="'.$add_text.'">'.$add_text.'</a> '.$small.'</span>'."\n";
		
		
		
		// --<
		return $comment_icon;
		
	}
	
	
	
	
	

	/** 
	 * @description: get the block paragraph icon
	 * @param integer $comment_count number of comments
	 * @param string $text_signature comment text signature
	 * @param string $block_type either 'auto', 'line' or 'block'
	 * @param integer $para_num sequnetial commentable block number
	 * @return string $comment_icon
	 * @todo: 
	 *
	 */
	function get_paragraph_icon( 
	
		$comment_count, 
		$text_signature, 
		$block_type = 'auto', 
		$para_num = 1 
		
	) { // -->
	
		// define block title by block type
		switch ( $block_type ) {
			
			// ----------------------------
			// auto-formatted
			// ----------------------------
			case 'auto':
			default:

				// define permalink text
				$permalink_text = sprintf( _n(
					
					// singular
					'Permalink for paragraph %d', 
					
					// plural
					'Permalink for paragraph %d', 
					
					// number
					$para_num, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $para_num );
				
				// define paragraph marker
				//$para_marker = '<span class="para_marker"><a id="'.$text_signature.'" href="#'.$text_signature.'" title="'.$permalink_text.'">&para; <span>'.(string) $para_num.'</span></a></span>';
				$para_marker = '<span class="para_marker"><a id="'.$text_signature.'" href="#'.$text_signature.'" title="'.$permalink_text.'"><span>'.(string) $para_num.'</span></a></span>';//JVDP
				
				break;
			
			// ----------------------------
			// line-by-line, eg poetry
			// ----------------------------
			case 'line':

				// define permalink text
				$permalink_text = sprintf( _n(
					
					// singular
					'Permalink for line %d', 
					
					// plural
					'Permalink for line %d', 
					
					// number
					$para_num, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $para_num );
				
				// define paragraph marker
				$para_marker = '<span class="para_marker"><a id="'.$text_signature.'" href="#'.$text_signature.'" title="'.$permalink_text.'">&para; <span>'.(string) $para_num.'</span></a></span>';
				
				break;
			

			// ----------------------------
			// comment-blocks
			// ----------------------------
			case 'block':

				// define permalink text
				$permalink_text = sprintf( _n(
					
					// singular
					'Permalink for block %d', 
					
					// plural
					'Permalink for block %d', 
					
					// number
					$para_num, 
					
					// domain
					'commentpress-core'
				
				// substitution
				), $para_num );
				
				// define paragraph marker
				$para_marker = '<span class="para_marker"><a id="'.$text_signature.'" href="#'.$text_signature.'" title="'.$permalink_text.'">&para; <span>'.(string) $para_num.'</span></a></span>';
				
				break;
		
		}
		
		// define HTML for paragraph icon
		$paragraph_icon = $para_marker."\n";
		
		
		
		// --<
		return $paragraph_icon;
		
	}
	
	
	
	
	

	/** 
	 * @description: get the content comment icon tag
	 * @param string $text_signature comment text signature
	 * @return string $para_tag
	 * @todo: 
	 *
	 */
	function get_para_tag( $text_signature, $commenticon, $tag = 'p' ) {
	
		// return different stuff for different tags
		switch( $tag ) {
		
			case 'ul':
		
				// define list tag
				$para_tag = '<'.$tag.' class="textblock" id="textblock-'.$text_signature.'">'.
							'<li class="list_commenticon">'.$commenticon.'</li>'; 
				break;
							
			case 'ol':
		
				// define list tag
				$para_tag = '<'.$tag.' class="textblock" id="textblock-'.$text_signature.'" start="0">'.
							'<li class="list_commenticon">'.$commenticon.'</li>'; 
				break;
			
			// compat with WP Footnotes
			case 'ol class="footnotes"':
		
				// define list tag
				$para_tag = '<ol class="footnotes textblock" id="textblock-'.$text_signature.'" start="0">'.
							'<li class="list_commenticon">'.$commenticon.'</li>'; 
				break;
							
			case 'p':
			case 'p style="text-align:left"':
			case 'p style="text-align:left;"':
			case 'p style="text-align: left"':
			case 'p style="text-align: left;"':
		
				// define para tag
				$para_tag = '<'.$tag.' class="textblock" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
			case 'p style="text-align:right"':
			case 'p style="text-align:right;"':
			case 'p style="text-align: right"':
			case 'p style="text-align: right;"':
		
				// define para tag
				$para_tag = '<'.$tag.' class="textblock textblock-right" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
			case 'p style="text-align:center"':
			case 'p style="text-align:center;"':
			case 'p style="text-align: center"':
			case 'p style="text-align: center;"':
		
				// define para tag
				$para_tag = '<'.$tag.' class="textblock textblock-center" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
			case 'p style="text-align:justify"':
			case 'p style="text-align:justify;"':
			case 'p style="text-align: justify"':
			case 'p style="text-align: justify;"':
		
				// define para tag
				$para_tag = '<'.$tag.' class="textblock textblock-justify" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
			case 'p class="notes"':
		
				// define para tag
				$para_tag = '<p class="notes textblock" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
			case 'div':
		
				// define opening tag (we'll close it later)
				$para_tag = '<div class="textblock" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
			case 'span':
		
				// define opening tag (we'll close it later)
				$para_tag = '<span class="textblock" id="textblock-'.$text_signature.'">'.$commenticon; 
				break;
							
		}
	

		
		/*
		print_r( array( 
		
			't' => $text_signature,
			'p' => $para_tag 
		
		) );
		*/



		// --<
		return $para_tag;
		
	}
	
	
	
	
	



	/** 
	 * @description: get the text signature input for the comment form
	 * @param string $text_sig comment text signature
	 * @return string $input
	 * @todo: 
	 *
	 */
	function get_signature_input( $text_sig = '' ) {
	
		// define input tag
		$input = '<input type="hidden" name="text_signature" value="'.$text_sig.'" id="text_signature" />';
		
		// --<
		return $input;
		
	}
	
	
	
	
	



	/** 
	 * @description: get the minimise all button
	 * @param: string $sidebar type of sidebar (comments, toc, activity)
	 * @return string $tag
	 * @todo: 
	 *
	 */
	function get_minimise_all_button( $sidebar = 'comments' ) {
	
		switch( $sidebar ) {
	
			case 'comments':
				// define minimise button
				$tag = '<span id="cp_minimise_all_comments" title="'.__( 'Minimise all Comment Sections', 'commentpress-core' ).'"></span>';
				break;
			
			case 'activity':
				// define minimise button
				$tag = '<span id="cp_minimise_all_activity" title="'.__( 'Minimise all Activity Sections', 'commentpress-core' ).'"></span>';
				break;
			
			case 'toc':
				// define minimise button
				$tag = '<span id="cp_minimise_all_contents" title="'.__( 'Minimise all Contents Sections', 'commentpress-core' ).'"></span>';
				break;
			
		}
		
		// --<
		return $tag;
		
	}
	
	
	
	
	



	/** 
	 * @description: get the header minimise button
	 * @return string $tag
	 * @todo: 
	 *
	 */
	function get_header_min_link() {
	
		// define minimise button
		$link = '<li><a href="#" id="btn_header_min" class="css_btn" title="'.__( 'Minimise Header', 'commentpress-core' ).'">'.__( 'Minimise Header', 'commentpress-core' ).'</a></li>'."\n";
		
		
		// --<
		return $link;
		
	}
	
	
	
	
	



	/** 
	 * @description: get an image wrapped in a link
	 * @param: string $src location of image file
	 * @param: string $url link target
	 * @return string $tag
	 * @todo: 
	 *
	 */
	function get_linked_image( $src = '', $url = '' ) {
	
		// init html
		$html = '';
	
		// do we have an image?
		if ( $src != '' ) {
	
			// construct link
			$html .= '<img src="'.$src.'" />';
		
		}

		// do we have one?
		if ( $url != '' ) {
	
			// construct link around image
			$html .= '<a href="'.$url.'">'.$html.'</a>';
			
		}
		
		
		
		// --<
		return $html;
		
	}
	
	
	
	
	



	/** 
	 * @description: got the Wordpress admin page
	 * @return string $admin_page
	 * @todo: 
	 *
	 */
	function get_admin_page() {
	
		// init
		$admin_page = '';
		
		
		
		// open div
		$admin_page .= '<div class="wrap" id="commentpress_admin_wrapper">'."\n\n";
	
		// get our form
		$admin_page .= $this->_get_admin_form();
		
		// close div
		$admin_page .= '</div>'."\n\n";
		
		
		
		// --<
		return $admin_page;
		
	}
	
	
	
	
	



//##############################################################################







	/*
	============================================================================
	PRIVATE METHODS
	============================================================================
	*/
	
	
	



	/*
	----------------------------------------------------------------------------
	Object Initialisation
	----------------------------------------------------------------------------
	*/
	
	/** 
	 * @description: object initialisation
	 * @todo:
	 *
	 */
	function _init() {
		
		// moved mobile checks to class_commentpress_db.php so it only loads as needed
		// and so that it loads *after* the old Commentpress loads it
		
	}







	/** 
	 * @description: returns the admin form HTML
	 * @return string $admin_page
	 * @todo: translation
	 *
	 */
	function _get_admin_form() {
	
		// sanitise admin page url
		$url = $_SERVER['REQUEST_URI'];
		$url_array = explode( '&', $url );
		if ( $url_array ) { $url = $url_array[0]; }



		// if we need to upgrade...
		if ( $this->db->check_upgrade() ) {
		
			// get upgrade options
			$upgrade = $this->_get_upgrade();
			
			// init text
			$options_text = '';
			
			// if there are options
			if ( $upgrade != '' ) {
				
				$options_text = __( ' The following options have become available in the new version.', 'commentpress-core' );
				
			}
			
			// define admin page
			$admin_page = '
<div class="icon32" id="icon-options-general"><br/></div>

<h2>'.__( 'CommentPress Core Upgrade', 'commentpress-core' ).'</h2>



<form method="post" action="'.htmlentities($url.'&updated=true').'">

'.wp_nonce_field( 'commentpress_admin_action', 'commentpress_nonce', true, false ).'
'.wp_referer_field( false ).'
<input id="cp_upgrade" name="cp_upgrade" value="1" type="hidden" />



<h3>'.__( 'Please upgrade CommentPress Core', 'commentpress-core' ).'</h3>

<p>'.__( 'It looks like you are running an older version of CommentPress Core.', 'commentpress-core' ).$options_text.'</p>



<table class="form-table">

'.$upgrade.'

</table>



'.
	


'<input type="hidden" name="action" value="update" />



<p class="submit">
	<input type="submit" name="commentpress_submit" value="'.__( 'Upgrade', 'commentpress-core' ).'" class="button-primary" />
</p>
				


</form>'."\n\n\n\n";

		} else {
		
			// define admin page
			$admin_page = '
<div class="icon32" id="icon-options-general"><br/></div>

<h2>'.__( 'CommentPress Core Settings', 'commentpress-core' ).'</h2>



<form method="post" action="'.htmlentities($url.'&updated=true').'">

'.wp_nonce_field( 'commentpress_admin_action', 'commentpress_nonce', true, false ).'
'.wp_referer_field( false ).'



'.

$this->_get_options().



'<input type="hidden" name="action" value="update" />



'.$this->_get_submit().'

</form>'."\n\n\n\n";

		}
		
		
		
		// --<
		return $admin_page;
		
	}
	
	
	
	
	



	/** 
	 * @description: returns the CommentPress Core options for the admin form
	 * @return string $options
	 * @todo: 
	 *
	 */
	function _get_options() {
	
		// define CommentPress Core theme options
		$options = '
<h3>'.__( 'Options for CommentPress Core', 'commentpress-core' ).'</h3>

<p>'.__( 'When the CommentPress Default Theme (or a valid CommentPress Child Theme) is active, the following options modify its behaviour.', 'commentpress-core' ).'</p>



<h4>'.__( 'Global Options', 'commentpress-core' ).'</h4>

<table class="form-table">

'.$this->_get_deactivate().'

'.$this->_get_reset().'

'.$this->_get_optional_options().'

</table>



<h4>'.__( 'Table of Contents', 'commentpress-core' ).'</h4>

<p>'.__( 'Choose how you want your Table of Contents to appear and function.<br />
<strong style="color: red;">NOTE!</strong> When Chapters are Pages, the TOC will always show Sub-Pages, since collapsing the TOC makes no sense in that situation.', 'commentpress-core' ).'</p>

<table class="form-table">

'.$this->_get_toc().'

</table>



<h4>'.__( 'Page Display Options', 'commentpress-core' ).'</h4>

<table class="form-table">

	<tr valign="top">
		<th scope="row"><label for="cp_title_visibility">'.__( 'Default page title visibility (can be overridden on individual pages)', 'commentpress-core' ).'</label></th>
		<td><select id="cp_title_visibility" name="cp_title_visibility">
				<option value="show" '.(($this->db->option_get('cp_title_visibility') == 'show') ? ' selected="selected"' : '').'>'.__( 'Show page titles', 'commentpress-core' ).'</option>
				<option value="hide" '.(($this->db->option_get('cp_title_visibility') == 'hide') ? ' selected="selected"' : '').'>'.__( 'Hide page titles', 'commentpress-core' ).'</option>
			</select>
		</td>
	</tr>

	<tr valign="top">
		<th scope="row"><label for="cp_page_meta_visibility">'.__( 'Default page meta visibility (can be overridden on individual pages)', 'commentpress-core' ).'</label></th>
		<td><select id="cp_page_meta_visibility" name="cp_page_meta_visibility">
				<option value="show" '.(($this->db->option_get('cp_page_meta_visibility') == 'show') ? ' selected="selected"' : '').'>'.__( 'Show page meta', 'commentpress-core' ).'</option>
				<option value="hide" '.(($this->db->option_get('cp_page_meta_visibility') == 'hide') ? ' selected="selected"' : '').'>'.__( 'Hide page meta', 'commentpress-core' ).'</option>
			</select>
		</td>
	</tr>

	<tr valign="top">
		<th scope="row"><label for="cp_excerpt_length">'.__( 'Blog excerpt length', 'commentpress-core' ).'</label></th>
		<td><input type="text" id="cp_excerpt_length" name="cp_excerpt_length" value="'.$this->db->option_get('cp_excerpt_length').'" class="small-text" /> '.__( 'words', 'commentpress-core' ).'</td>
	</tr>

</table>



<h4>'.__( 'Commenting Options', 'commentpress-core' ).'</h4>

<table class="form-table">

'.$this->_get_editor().'

'.$this->_get_override().'

</table>



<h4>'.__( 'Theme Customisation', 'commentpress-core' ).'</h4>

<p>'.__( 'You can set a custom background colour in <em>Appearance &#8594; Background</em>.<br />
You can also set a custom header image and header text colour in <em>Appearance &#8594; Header</em>.<br />
Below are extra options for changing how the theme looks.', 'commentpress-core' ).'</p>

<table class="form-table">

	<tr valign="top" id="cp_header_bg_colour-row">
		<th scope="row"><label for="cp_header_bg_colour">'.__( 'Header Background Colour', 'commentpress-core' ).'</label></th>
		<td><input type="text" name="cp_header_bg_colour" id="cp_header_bg_colour" value="'.$this->db->option_get('cp_header_bg_colour').'" /><span class="description hide-if-js">'.__( 'If you want to hide header text, add <strong>#blank</strong> as text colour.', 'commentpress-core' ).'</span><input type="button" class="button hide-if-no-js" value="'.__( 'Select a Colour', 'commentpress-core' ).'" id="pickcolor" /><div id="color-picker" style="z-index: 100; background:#eee; border:1px solid #ccc; position:absolute; display:none;"></div></td>
	</tr>
	
	<tr valign="top">
		<th scope="row"><label for="cp_js_scroll_speed">'.__( 'Scroll speed', 'commentpress-core' ).'</label></th>
		<td><input type="text" id="cp_js_scroll_speed" name="cp_js_scroll_speed" value="'.$this->db->option_get('cp_js_scroll_speed').'" class="small-text" /> '.__( 'milliseconds', 'commentpress-core' ).'</td>
	</tr>

	<tr valign="top">
		<th scope="row"><label for="cp_min_page_width">'.__( 'Minimum page width', 'commentpress-core' ).'</label></th>
		<td><input type="text" id="cp_min_page_width" name="cp_min_page_width" value="'.$this->db->option_get('cp_min_page_width').'" class="small-text" /> '.__( 'pixels', 'commentpress-core' ).'</td>
	</tr>

'.$this->_get_sidebar().'

</table>



';
	
		

		// --<
		return $options;
		
	}
	
	
	
	
	



	/** 
	 * @description: returns optional options, if defined
	 * @return string $html
	 * @todo: 
	 *
	 */
	function _get_optional_options() {
	
		// init
		$html = '';
	
	
	
		// do we have the option to choose blog type (new in 3.3.1)?
		if ( $this->db->option_exists( 'cp_blog_type' ) ) {
		
			// define no types
			$types = array();
			
			// allow overrides
			$types = apply_filters( 'cp_blog_type_options', $types );
			
			// if we get some from a plugin, say...
			if ( !empty( $types ) ) {
			
				// define title
				$type_title = __( 'Default Text Format', 'commentpress-core' );
			
				// allow overrides
				$type_title = apply_filters( 'cp_blog_type_label', $type_title );
				
				// add extra message
				$type_title .= __( ' (can be overridden on individual pages)', 'commentpress-core' );
			
				// construct options
				$type_option_list = array();
				$n = 0;
				
				// get existing
				$blog_type = $this->db->option_get( 'cp_blog_type' );
				
				foreach( $types AS $type ) {
					if ( $n == $blog_type ) {
						$type_option_list[] = '<option value="'.$n.'" selected="selected">'.$type.'</option>';
					} else {
						$type_option_list[] = '<option value="'.$n.'">'.$type.'</option>';
					}
					$n++;
				}
				$type_options = implode( "\n", $type_option_list );
				
				
				
				// define upgrade
				$html .= '
	<tr valign="top">
		<th scope="row"><label for="cp_blog_type">'.$type_title.'</label></th>
		<td><select id="cp_blog_type" name="cp_blog_type">
				'.$type_options.'
			</select>
		</td>
	</tr>

';

			}

		}
		

		
		// do we have the option to choose blog workflow (new in 3.3.1)?
		if ( $this->db->option_exists( 'cp_blog_workflow' ) ) {
		
			// off by default
			$has_workflow = false;
		
			// allow overrides
			$has_workflow = apply_filters( 'cp_blog_workflow_exists', $has_workflow );
			
			// if we have workflow enabled, by a plugin, say...
			if ( $has_workflow !== false ) {
			
				// define label
				$workflow_label = __( 'Enable Custom Workflow', 'commentpress-core' );
			
				// define label
				$workflow_label = apply_filters( 'cp_blog_workflow_label', $workflow_label );
				
				// add extra message
				$workflow_label .= ' (Not recommended because it is still very experimental)';
			
				// define upgrade
				$html .= '
	<tr valign="top">
		<th scope="row"><label for="cp_blog_workflow">'.$workflow_label.'</label></th>
		<td><input id="cp_blog_workflow" name="cp_blog_workflow" value="1" type="checkbox" '.( $this->db->option_get('cp_blog_workflow') ? ' checked="checked"' : ''  ).' /></td>

	</tr>

';

			}

		}
		
		
		
		// --<
		return $html;
		
	}
	
	
	
	
	
		

		
	/** 
	 * @description: returns the upgrade details for the admin form
	 * @return string $upgrade
	 * @todo: 
	 *
	 */
	function _get_upgrade() {
		
		// init
		$upgrade = '';
		
		
		
		// do we have the option to choose the default sidebar (new in 3.3.3)?
		if ( !$this->db->option_exists( 'cp_sidebar_default' ) ) {
		
			// define labels
			$label = __( 'Which sidebar do you want to be active by default? (can be overridden on individual pages)', 'commentpress-core' );
			$contents_label = __( 'Contents', 'commentpress-core' );
			$activity_label = __( 'Activity', 'commentpress-core' );
			$comments_label = __( 'Comments', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_sidebar_default">'.$label.'</label></th>
		<td><select id="cp_sidebar_default" name="cp_sidebar_default">
				<option value="toc">'.$contents_label.'</option>
				<option value="activity">'.$activity_label.'</option>
				<option value="comments" selected="selected">'.$comments_label.'</option>
			</select>
		</td>
	</tr>

';

		}
		

		
		// do we have the option to show or hide page meta (new in 3.3.2)?
		if ( !$this->db->option_exists( 'cp_page_meta_visibility' ) ) {
		
			$meta_label = __( 'Show or hide page meta by default', 'commentpress-core' );
			$meta_show_label = __( 'Show page meta', 'commentpress-core' );
			$meta_hide_label = __( 'Hide page meta', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_page_meta_visibility">'.$meta_label.'</label></th>
		<td><select id="cp_page_meta_visibility" name="cp_page_meta_visibility">
				<option value="show">'.$meta_show_label.'</option>
				<option value="hide" selected="selected">'.$meta_hide_label.'</option>
			</select>
		</td>
	</tr>
';

		}
		

		
		// do we have the option to choose blog type (new in 3.3.1)?
		if ( !$this->db->option_exists( 'cp_blog_type' ) ) {
		
			// define no types
			$types = array();
			
			// allow overrides
			$types = apply_filters( 'cp_blog_type_options', $types );
			
			// if we get some from a plugin, say...
			if ( !empty( $types ) ) {
			
				// define title
				$type_title = __( 'Blog Type', 'commentpress-core' );
			
				// allow overrides
				$type_title = apply_filters( 'cp_blog_type_label', $type_title );
			
				// construct options
				$type_option_list = array();
				$n = 0;
				foreach( $types AS $type ) {
					$type_option_list[] = '<option value="'.$n.'">'.$type.'</option>';
					$n++;
				}
				$type_options = implode( "\n", $type_option_list );
				
				
				
				// define upgrade
				$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_blog_type">'.$type_title.'</label></th>
		<td><select id="cp_blog_type" name="cp_blog_type">
				'.$type_options.'
			</select>
		</td>
	</tr>

';

			}

		}
		

		
		// do we have the option to choose blog workflow (new in 3.3.1)?
		if ( !$this->db->option_exists( 'cp_blog_workflow' ) ) {
		
			// off by default
			$has_workflow = false;
		
			// allow overrides
			$has_workflow = apply_filters( 'cp_blog_workflow_exists', $has_workflow );
			
			// if we have workflow enabled, by a plugin, say...
			if ( $has_workflow !== false ) {
			
				// define label
				$workflow_label = __( 'Enable Custom Workflow', 'commentpress-core' );
			
				// define label
				$workflow_label = apply_filters( 'cp_blog_workflow_label', $workflow_label );
			
				// define upgrade
				$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_blog_workflow">'.$workflow_label.'</label></th>
		<td><input id="cp_reset" name="cp_blog_workflow" value="1" type="checkbox" /></td>
	</tr>

';

			}

		}
		

		
		// do we have the option to choose the TOC layout (new in 3.3)?
		if ( !$this->db->option_exists( 'cp_show_extended_toc' ) ) {
		
			$extended_label = __( 'Appearance of TOC for posts', 'commentpress-core' );
			$extended_info_label = __( 'Extended information', 'commentpress-core' );
			$extended_title_label = __( 'Just the title', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_show_extended_toc">'.$extended_label.'</label></th>
		<td><select id="cp_show_extended_toc" name="cp_show_extended_toc">
				<option value="1">'.$extended_info_label.'</option>
				<option value="0" selected="selected">'.$extended_title_label.'</option>
			</select>
		</td>
	</tr>

';

		}
		

		
		// do we have the option to set the comment editor?
		if ( !$this->db->option_exists( 'cp_comment_editor' ) ) {
		
			$editor_label = __( 'Comment form editor', 'commentpress-core' );
			$rich_label = __( 'Rich-text Editor', 'commentpress-core' );
			$plain_label = __( 'Plain-text Editor', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_comment_editor">'.$editor_label.'</label></th>
		<td><select id="cp_comment_editor" name="cp_comment_editor">
				<option value="1" selected="selected">'.$rich_label.'</option>
				<option value="0">'.$plain_label.'</option>
			</select>
		</td>
	</tr>
';
		
		}
		

		
		// do we have the option to set the default behaviour?
		if ( !$this->db->option_exists( 'cp_promote_reading' ) ) {
		
			$behaviour_label = __( 'Default comment form behaviour', 'commentpress-core' );
			$reading_label = __( 'Promote reading', 'commentpress-core' );
			$commenting_label = __( 'Promote commenting', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_promote_reading">'.$behaviour_label.'</label></th>
		<td><select id="cp_promote_reading" name="cp_promote_reading">
				<option value="1">'.$reading_label.'</option>
				<option value="0" selected="selected">'.$commenting_label.'</option>
			</select>
		</td>
	</tr>
';

		}
		

		
		// do we have the option to show or hide titles?
		if ( !$this->db->option_exists( 'cp_title_visibility' ) ) {
		
			// define labels
			$titles_label = __( 'Show or hide page titles by default', 'commentpress-core' );
			$titles_select_show = __( 'Show page titles', 'commentpress-core' );
			$titles_select_hide = __( 'Hide page titles', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_title_visibility">'.$titles_label.'</label></th>
		<td><select id="cp_title_visibility" name="cp_title_visibility">
				<option value="show" selected="selected">'.$titles_select_show.'</option>
				<option value="hide">'.$titles_select_hide.'</option>
			</select>
		</td>
	</tr>
';

		}
		

		
		// do we have the option to set the header bg colour?
		if ( !$this->db->option_exists( 'cp_header_bg_colour' ) ) {
		
			// define labels
			$colour_label = __( 'Header Background Colour', 'commentpress-core' );
			$colour_select_text = __( 'If you want to hide header text, add <strong>#blank</strong> as text colour.', 'commentpress-core' );
			$colour_select_label = __( 'Select a Colour', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top" id="cp_header_bg_colour-row">
		<th scope="row"><label for="cp_header_bg_colour">'.$colour_label.'</label></th>
		<td><input type="text" name="cp_header_bg_colour" id="cp_header_bg_colour" value="'.$this->db->header_bg_colour.'" /><span class="description hide-if-js">'.$colour_select_text.'</span><input type="button" class="button hide-if-no-js" value="'.$colour_select_label.'" id="pickcolor" /><div id="color-picker" style="z-index: 100; background:#eee; border:1px solid #ccc; position:absolute; display:none;"></div></td>
	</tr>
	
';

		}
		

		
		// do we have the option to set the scroll speed?
		if ( !$this->db->option_exists( 'cp_js_scroll_speed' ) ) {
		
			// define labels
			$scroll_label = __( 'Scroll speed', 'commentpress-core' );
			$scroll_ms_label = __( 'milliseconds', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_js_scroll_speed">'.$scroll_label.'</label></th>
		<td><input type="text" id="cp_js_scroll_speed" name="cp_js_scroll_speed" value="'.$this->db->js_scroll_speed.'" class="small-text" /> '.$scroll_ms_label.'</td>
	</tr>

';

		}
		

		
		// do we have the option to set the minimum page width?
		if ( !$this->db->option_exists( 'cp_min_page_width' ) ) {
		
			// define labels
			$min_label = __( 'Minimum page width', 'commentpress-core' );
			$min_pix_label = __( 'pixels', 'commentpress-core' );
	
			// define upgrade
			$upgrade .= '
	<tr valign="top">
		<th scope="row"><label for="cp_min_page_width"></label></th>
		<td><input type="text" id="cp_min_page_width" name="cp_min_page_width" value="'.$this->db->min_page_width.'" class="small-text" /> '.$min_pix_label.'</td>
	</tr>

';

		}
		

		
		// --<
		return $upgrade;
		
	}
	
	
	
	
	



	/** 
	 * @description: returns the multisite deactivate button for the admin form
	 * @return string $html
	 * @todo: 
	 *
	 */
	function _get_deacti…