ThemeShaper Forums » Development Talk

[closed]

Contribute to Thematic's Docs/Wiki

(43 posts)
  • Started 13 years ago by em hr
  • Latest reply from gloriaantonelli
  1. We have discussed a need for better organized docs. Hopefully this will lighten the load of regularly asked questions in the forums, aid in discovery of useful code, and keep us all more productive.

    Changes and improvements to the Official Thematic Wiki are on the way but it will take a little time to get things set up. At the moment this forum is the only outlet open for contributions from all community members. It's not ideal but it's what we have at hand.

    We know that many of these Frequently asked questions have been answered in the forums and that the code snippets to resolve these questions buried are in here.

    So, if you want to contribute, here is you chance

    If you can't think of anything here is a suggestion:

    Dig around and post links to forum threads that:

    1. Are worthy of inclusion the wiki/docs
    2. Answer frequently asked questions
    Posted 13 years ago #
  2. i'm probably being dumb here. but dont quite understand.

    post HERE, links that have provided a solid answer.

    Posted 13 years ago #
  3. I've edited the original post simplifying things a bit. Is that clearer now? and re-edited to open things up a bit.

    Posted 13 years ago #
  4. Thompson
    Member

    How about important stuff straight from our functions.php? One of my favorites:

    // JS - MOVE TO FOOTER
    remove_action('wp_head', 'wp_print_scripts');
    remove_action('wp_head', 'wp_print_head_scripts', 9);
    remove_action('wp_head', 'wp_enqueue_scripts', 1);
    add_action('wp_footer', 'wp_print_scripts', 1);
    add_action('wp_footer', 'wp_enqueue_scripts', 1);
    add_action('wp_footer', 'wp_print_head_scripts', 1);

    Posted 13 years ago #
  5. Thompson
    Member

    Remove unneeded header links:


    // CLEAN UP HEADER
    remove_action( 'wp_head', 'wlwmanifest_link'); // Remvoes link for Windows Live Writer users
    remove_action( 'wp_head', 'wp_generator'); // Removes WP version
    remove_action( 'wp_head', 'rsd_link' ); // Removes unneeded Really Simple Discovery link
    remove_action( 'wp_head', 'start_post_rel_link'); //Remove relational start link
    remove_action( 'wp_head', 'adjacent_posts_rel_link_wp_head'); // Remove prev/next relational links

    Posted 13 years ago #
  6. Thompson
    Member


    // Change Thematic doctype to HTML5
    function childtheme_create_doctype() {
    return '<!DOCTYPE html><html';
    }
    add_filter('thematic_create_doctype', 'childtheme_create_doctype');

    Posted 13 years ago #
  7. Thanks for sharing Thompson :) I too like a clean head. Note that the wp_generator is already removed by Thematic.

    This also brings to mind whether the official Thematic Docs should include general (non-Thematic) snippets.

    Links to valuable forum threads, personal code favorites, or whatever. If you wanna share something that could be of value to Thematic's docs. Here's the place.

    Posted 13 years ago #
  8. hi all, gene i'm back on the internet, so hopefully i can be more helpful once i've caught up a bit.

    i am partial to a few of my own threads :) :
    http://forums.themeshaper.com/topic/thematic-menus-demystified-1
    http://forums.themeshaper.com/topic/jquery-in-thematic-demystified
    http://forums.themeshaper.com/topic/comment-layout#post-17041

    related to that last one- i would love to see comments become easier to modify. they are a bear right now.

    i thought this was also a really neat one:
    http://forums.themeshaper.com/topic/tip-modify-thematic-page-title

    excerpts are always a common question. how to use excerpts on the home page. how to show full posts on a category page. that sort of thing.

    also i know that there is technically an explanation of hooks and filters, but i'd like to see it start from scratch. as we know, once a users understands hooks and filters (and especially hooks) alot of the questions can be simplified down to "how to add an action to a hook". i think of hooks like a coat rack. thematic has some coats hanging up, and has conveniently left us some empty pegs. you can remove coats from their pegs, add more than one coat to a peg, or add a coat to an empty peg.

    function add_something(){
      echo "add some bacon!";
    }
    add_action('thematic_hook_you_want_to_add_function_to','add_something');

    @Thompson- i tried to move my scripts to the footer and the dropdowns stopped working. do they still work for you?

    Posted 13 years ago #
  9. We need a complete guide to widgets. I put examples in this forum post here: http://forums.themeshaper.com/topic/adjusting-widgetized-areas#post-4605

    But this is the post that really helped me understand it: http://forums.themeshaper.com/topic/does-anyone-know-when-the-next-version-of-the-thematic-theme-will-come-out#post-7050

    We need to condense it all and put it in a single spot.

    Posted 13 years ago #
  10. kwight
    Member

    Thematic's override functions were invaluable to me while getting my head around working with hooks and filters. At the time, I put together a quick text document that listed them all, broken down by the file in which they are located:

    http://kirkwight.com/thematic/thematic_overrides.txt

    Two other great high-level references for Thematic are the Thematic structure diagram at bluemandala.com:

    http://bluemandala.com/thematic/thematic-structure.html

    ...and Chris' Visualizing Thematic page:

    http://visualizing.thematic4you.com/

    I'm sure these are quite useful to anyone starting out with Thematic.

    Posted 13 years ago #
  11. Pictrix
    Member

    If I remember correctly, this discussion was sparked by the fact that it is rather difficult to find information quickly and that the forum receives a lot of repeat questions. I'm confident that having a Table of Contents that beginning and experienced users can use as a starting point for finding the information they need should be the basis for this project.

    First, it will give structure and help set priorities for the wiki/docs development project.

    Second, once it is set up in whatever framework it will reside, it will make it very easy to just cut and paste from the wiki/docs volunteers' favorite posts without having to reinvent the wheel.

    Third, it will be easy to modify as needed as the project progresses. I can't stress enough that the current wiki and the forum is a goldmine of information, we just need to give it some structure and organize it.

    After consulting the Wordpress Codex Main Page and the tag cloud at the ThemeShaper Forums, I came up with a tentative Table of Contents that I hereby submit for discussion:

    Table of Contents

    • Introduction - Getting Started with Thematic »
      • New To Thematic - How it Works
      • Child Themes for Beginners
      • Child Theme examples
      • FAQ - New To Thematic
    • Thematic 0.9.7.7 Information »
      • Features
      • Thematic Support Forums
    • Installation »
      • Download Thematic
      • Installing Thematic
      • Creating a Child Theme
    • Working with a Thematic Child Theme »
      • Working with functions.php
      • Working with Hooks - Basics and Sintax
      • Working with Filters - Basics and Sintax
      • Backing Up a Child Theme
      • FAQ - Child Themes
    • Styling Thematic - CSS »
      • Default Thematic CSS Styling
      • Thematic Classes
      • Customizing the Styling of a Child Theme with CSS
        • Head
        • Header
        • Menus
        • Content
        • Sidebars
        • Footer
        • Widgets
        • Images
        • Links
      • Troubleshooting - CSS
      • Resources - CSS
      • FAQ - Styling Thematic - CSS
    • Modifying the Thematic Structure - PHP »
      • The Thematic Structure
      • Customizing the Structure of a Child Theme with PHP
        • Head
        • Header
        • Menus
        • Content
        • Sidebars
        • Footer
        • Widgets
        • Scripts - Jquery
        • Pages
        • Loop
        • Posts
        • Navigation
        • Comments
      • Troubleshooting - functions.php
      • Resources - PHP
      • FAQ - Modifying the Thematic Structure - PHP
    • Customization with Plugins »
      • Working with Plugins
      • Resources - Plugins that work well with Thematic
    • Advanced Topics »
      • FAQ - Advanced Topics
    • Troubleshooting »
      • Finding Answers
      • Using the Support Forums
      • FAQ - New To Thematic
      • FAQ - Child Themes
      • FAQ - Styling Thematic - CSS
      • FAQ - Modifying the Thematic Structure - PHP
      • FAQ - About Thematic
      • FAQ - Developers
      • FAQ - Advanced Topics
    • Developer Documentation »
      • Contributing to Thematic
      • Thematic Developer Documentation
      • FAQ - Developers
      • Thematic Coding Standards
    • About Thematic »
      • About Thematic
      • Thematic Features
      • Thematic Versions
      • FAQ - About Thematic
      • Contributing to Thematic
      • About the Thematic Wiki/Docs
      • Thematic Wiki/Docs Guidelines
      • Volunteers Needed for the Thematic Wiki/Docs Documentation
    • Help Improve the Thematic Wiki/Docs
      • Ways to Contribute with Thematic
    • Alphabetical index

    format edited by Helga - 3/13/2012

    Posted 13 years ago #
  12. Pictrix
    Member

    Sorry! The styling of my previous post ended up getting terribly messed up.
    Please! If someone can fix it please do so.
    Thanks!

    Posted 13 years ago #
  13. Thanks everybody. This is shaping up great.

    Posted 13 years ago #
  14. Pictrix - that's amazeballs. i think we have a winner.

    Posted 13 years ago #
  15. kwight
    Member

    Sweet ToC, great stuff.

    The domain thematic.info just became available again, so I snapped it up. I'm happy to contribute it (first year is paid) for whatever purpose we see fit, if any.

    Posted 13 years ago #
  16. so gene- how is it coming? what can we do to help?

    Posted 13 years ago #
  17. Good work on that list Pictrix, or as Helga said, amazeballs!

    Posted 13 years ago #
  18. For now, here are topics I've started myself that have been resolved with the help of the community:

    Placing the thumbnail before entry title instead of after entry meta:
    http://forums.themeshaper.com/topic/placing-thumbnail-before-entry-title-instead-of-after-entry-meta

    Adding a list of recent posts to a custom page template:
    http://forums.themeshaper.com/topic/adding-a-list-of-recent-posts-to-a-custom-page-template

    The sidebar: Hooking and styling above,below and main asides:
    http://forums.themeshaper.com/topic/thematic-sidebar-problem-above-below-and-between-main-asides

    Regarding the second link it would be great to have the following highlighted in a very obvious manner:

        The thematic_content filter resides in thematic_content_init().
        thematic_content_init() is hooked to thematic_abovepost().
        Any custom loop therefore requires thematic_abovepost() to correctly apply thematic_content filters.

    More on this in this thread here: http://forums.themeshaper.com/topic/adding-a-list-of-recent-posts-to-a-custom-page-template#post-18210

    Can someone sort out the styling of Pictrix's post?

    Posted 13 years ago #
  19. Here are a few of the code snippets I use in my functions.php file that could be of benefit to fellow novices:

    // Remove thematic_header.
    function clear_header() {
    	remove_all_actions('thematic_header');
    }
    add_action('init', 'clear_header');
    
    // Replace with custom_header.
    function custom_header() {
        ?>
        <?php include($_SERVER['DOCUMENT_ROOT']."/wp-content/themes/you-theme-name/custom-header.php"); ?>
       <?php
    }
    add_action('thematic_aboveheader','custom_header');
    // Add favicon for child theme.
    function childtheme_favicon() { ?>
    	<link rel="shortcut icon" href="<?php echo bloginfo('stylesheet_directory') ?>/favicon.png" />
    <?php }
    add_action('wp_head', 'childtheme_favicon');

    The following is useful for adding js/css files and jQuery snippets et al...

    // Add additional information to <head>.
    function custom_links() { ?>
    <?php include($_SERVER['DOCUMENT_ROOT']."/directsponsor/wp-content/themes/directsponsor/custom-head.php"); ?>
    <?php }
    add_action('wp_head', 'custom_links');
    // Conditionally add graphical heading to page content.
    // This is useful if you need to apply non-browser-safe font in a graphical manner rather than textually e.g. purely for aesthetics.
    function add_content_heading() {
        ?>
        <?php
    	if ( is_page('home') ){$heading = "home";}
    	if ( is_page('about') ){$heading = "about";}
    	if (  is_home() || is_single() || is_archive() || is_category() || is_404() || is_attachment() || is_preview() || is_search() ){$heading = "blog";}
    	if ( is_page('contact') ){$heading = "contact";} if ( is_archive() ){$heading = "contact";}
    	if ( is_archive() ){$heading = "archive";}
    	if ( is_category() ){$heading = "category";}
    	if ( is_author() ){$heading = "author";}
    	if ( is_search() ){$heading = "search";}
    	if ( is_404() ){$heading = "404";}
    	if ( is_attachment() ){$heading = "attachment";} 
    
    	?>
        <div class="content_heading"><img src="<?php echo bloginfo('stylesheet_directory') ?>/images/heading-<?php echo $heading ?>.png" /></div>
       <?php
    }
    add_action('thematic_abovecontent','add_content_headings');	
    
    // Add graphical bottom to page content
    function add_content_bottom() {
        ?>
        <div class="content_bottom"></div>
       <?php
    }
    add_action('thematic_belowcontent','add_content_bottom');
    // Add graphics before, between and after the primary and secondary asides:
    
    // Add graphical heading for primary aside.
    function add_heading_abovemainasides() {
        ?>
        <div class="heading-widget aside main-aside"><img src="<?php echo bloginfo('stylesheet_directory') ?>/images/heading-primary.png" /></div>
       <?php
    }
    add_action('thematic_abovemainasides','add_heading_abovemainasides');	
    
    // Graphical bottom for primary aside and then graphical heading for secondary aside.
    function add_headingbottom_betweenmainasides() {
        ?>
        <div class="aside main-aside bottom-primary"></div>
        <div class="heading-widget aside main-aside"><img src="<?php echo bloginfo('stylesheet_directory') ?>/images/heading-secondary.png" /></div>
       <?php
    }
    add_action('thematic_betweenmainasides','add_headingbottom_betweenmainasides');	
    
    // Add custom bottom for secondary aside.
    function add_bottom_belowmainasides() {
        ?>
        <div class="aside main-aside bottom-secondary"></div>
       <?php
    }
    add_action('thematic_belowmainasides','add_bottom_belowmainasides');
    // Replace navigation above and below with customized navigation i.e. replace the next and previous post links with the words 'next' and 'previous' and instead apply the post title to the tooltip:
    // The additional values in the array are used with the following plugin: http://wordpress.org/extend/plugins/ambrosite-nextprevious-post-link-plus/
    
    function add_custom_navigation_above() {
    	if (is_single()) {
    	?>
    		    <div id="nav-above" class="navigation">
    	            <div class="nav-previous">
                        <?php previous_post_link_plus( array(
                        'order_by' => 'post_date', //default
                        'order_2nd' => 'post_date', //default
                        'meta_key' => '',
                        'loop' => false,
                        'thumb' => false,
                        'max_length' => 0,
                        'format' => '%link',
                        'link' => 'Previous', //changes the link without changing the tooltip.
                        'before' => '',
                        'after' => '',
                        'in_same_cat' => false,
                        'ex_cats' => '',
                        'num_results' => 1,
                        'echo' => true
                        ) ); ?>
                        </div>
    
                        <div class="nav-next">
    	            <?php next_post_link_plus( array(
                        'order_by' => 'post_date', //default
                        'order_2nd' => 'post_date', //default
                        'meta_key' => '',
                        'loop' => false,
                        'thumb' => false,
                        'max_length' => 0,
                        'format' => '%link',
                        'link' => 'Next', //changes the link without changing the tooltip.
                        'before' => '',
                        'after' => '',
                        'in_same_cat' => false,
                        'ex_cats' => '',
                        'num_results' => 1,
                        'echo' => true
                        ) ); ?>
                        </div>
    				</div>
       <?php
    	}// end if single.
    	else {
    		?>
    
    				<div id="nav-above" class="navigation">
                   		<?php if(function_exists('wp_pagenavi')) { ?>
                    	<?php wp_pagenavi(); ?>
    					<?php } else { ?>
    					<div class="nav-previous"><?php next_posts_link(__('Older', 'thematic')) ?></div>
    					<div class="nav-next"><?php previous_posts_link(__('Newer', 'thematic')) ?></div>
    					<?php } ?>
    
    				</div>	
    
    <?php
    	}// end else.
    }
    add_action('thematic_navigation_above','add_custom_navigation_above');
    
    function add_custom_navigation_below() {
    	if (is_single()) {
    	?>
    	            <div id="nav-below" class="navigation">
    	            <div class="nav-previous">
                        <?php previous_post_link_plus( array(
                        'order_by' => 'post_date', //default
                        'order_2nd' => 'post_date', //default
                        'meta_key' => '',
                        'loop' => false,
                        'thumb' => false,
                        'max_length' => 0,
                        'format' => '%link',
                        'link' => 'Previous', //changes the link without changing the tooltip.
                        'before' => '',
                        'after' => '',
                        'in_same_cat' => false,
                        'ex_cats' => '',
                        'num_results' => 1,
                        'echo' => true
                        ) ); ?>
                        </div>
    
    		    <div class="nav-next">
    		    <?php next_post_link_plus( array(
                        'order_by' => 'post_date', //default
                        'order_2nd' => 'post_date', //default
                        'meta_key' => '',
                        'loop' => false,
                        'thumb' => false,
                        'max_length' => 0,
                        'format' => '%link',
                        'link' => 'Next', //changes the link without changing the tooltip.
                        'before' => '',
                        'after' => '',
                        'in_same_cat' => false,
                        'ex_cats' => '',
                        'num_results' => 1,
                        'echo' => true
                        ) ); ?>
                        </div>
    				</div>
       <?php
    	}// end if single.
    	else {
    		?>
    
    				<div id="nav-below" class="navigation">
                   		<?php if(function_exists('wp_pagenavi')) { ?>
                    	<?php wp_pagenavi(); ?>
    					<?php } else { ?>
    					<div class="nav-previous"><?php next_posts_link(__('Older', 'thematic')) ?></div>
    					<div class="nav-next"><?php previous_posts_link(__('Newer', 'thematic')) ?></div>
    					<?php } ?>
    
    				</div>	
    
    <?php
    	}// end else.
    }
    add_action('thematic_navigation_below','add_custom_navigation_below');

    Hope some/any of this is of use.

    The code is probably far from perfect but at the very least it provides a basis of the needs I've had and others might have for functions for the Thematic framework

    Posted 13 years ago #
  20. Not all WordPress plugins work with the Thematic Framework. A list of the following would be useful:

    - Plugins that work with Thematic.
    - Plugins that conflict with Thematic.
    - Available solutions for conflicting plugins.

    Naturally each entry would only be relative to the plugin version and Thematic version.

    This would narrow down the trial and error process.

    A neglected precursor already exists on the forum here: http://forums.themeshaper.com/topic/this-plugin-doesnt-work-with-thematic

    Posted 13 years ago #
  21. I think the outreach for community contribution and collaboration needs to be far more aggressive. Can we not get a banner added to the forum #header or distribute a mass email to the forum member base?

    I'm certain that there is an abundance of prospective contributers who have little idea that the docswiki project is currently underway, especially considering that the future of Thematic is in their interests.

    Posted 13 years ago #
  22. Pictrix
    Member

    Another suggestion:
    Since we have a starting point with kwight’s kind donation, we could just set up a wordpress site and add the thematic theme to it. The front page will be the Table of Contents (TOC), and the pages, sub-pages and sub-sub-pages will be the topics. No blog functionality.

    With WordPress inherent user role structure, it would be very easy for contributors to post entries and for someone to ensure that they get classified correctly to ensure cohesiveness. We may develop standards for contributors to adhere to.
    Actually, the idea and the information in the Thematic Guide (wiki) is quite valuable, but it could use a TOC, index or a structure more conductive to finding information quickly. If most Thematic users are like me the question they have in mind is “How do I change this?”

    On a different note: Please! Can someone fix the styling of my list above? It is too hard to read.

    Posted 13 years ago #
  23. Hi Pictrix,

    I'm not sure what you are going for with the styling... So go ahead and repost it the way you would like it to be styled. And I'll make the appropriate notation in your previous post when you are ready.

    -Gene

    Posted 13 years ago #
  24. Pictrix
    Member

    Thanks Gene,
    I was just going for a 3-level nested unordered list. If you check view-source you'll see the exactly the coding that I used. It would have come out fine, but it seems that I ran out of the grey background. Should I just use paragraphs and spaces to denote the different levels?

    Posted 13 years ago #
  25. the list looks fine, but the forum page now looks wonky. and i'd just like to echo again that your TOC looks like it will make a killer place to start.

    Posted 13 years ago #
  26. Pictrix I think you should add "Donate to Thematic" in there somewhere.

    Posted 13 years ago #
  27. elderberry
    Member

    I'm not much of a coder, but I like to organize things. If kwight will sign me up as a user on thematic.info I will help migrate some of this content according to the nice TOC listed above. ?

    Posted 13 years ago #
  28. hold off just a bit longer elderberry. it is frustrating for sure, but due to the recent changes at themeshaper.com thematic should be finding a new home soon. hopefully by the weekend. cross fingers and press thumbs that chris or gene will have more of an announcement in the very near future.

    Posted 13 years ago #
  29. elderberry
    Member

    Ok. I like this theme a lot and will do whatever I can to make it easier to use and have a long life :-)

    Posted 13 years ago #
  30. Pictrix I already feel smarter and more organized just reading your TOC :)

    Posted 13 years ago #

RSS feed for this topic

Topic Closed

This topic has been closed to new replies.