framework/sage
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Scott Walkinshaw
2012-09-19 14:38:13 -04:00
parent b61a3b0285
commit 38a51d06ec
3 changed files with 10 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@@ -1,4 +1,6 @@
### 6.0.0: September 16th, 2012 ### 6.0.0: September 16th, 2012
* Move custom entry_meta code into template
* Move Google Analytics code into footer template
* Simplify nav walker and support 3rd level dropdowns * Simplify nav walker and support 3rd level dropdowns
* Update to Bootstrap 2.1.1, jQuery 1.8.1, Modernizr 2.6.2 * Update to Bootstrap 2.1.1, jQuery 1.8.1, Modernizr 2.6.2
* Add bundled docs * Add bundled docs

17
doc/lib.md
View File

@@ -3,14 +3,6 @@ table of contents](README.md)
# Theme library # Theme library
### actions.php
This file is used to hook into [WordPress actions](http://codex.wordpress.org/Plugin_API/Action_Reference).
The `roots_feed_link()` function is used to hook into `wp_head()` to return a feed link if your site has any posts.
The `roots_google_analytics()` function is used to hook into `wp_footer()` to return the [asynchronous Google Analytics snippet](http://mathiasbynens.be/notes/async-analytics-snippet) from HTML5 Boilerplate if an ID is defined in `config.php`.
### activation.php ### activation.php
This file handles the theme activation. [About the theme activation](activation.md). This file handles the theme activation. [About the theme activation](activation.md).
@@ -106,13 +98,6 @@ Learn about `plugins.js` and `main.js` in the HTML5 Boilerplate [JavaScript docs
It's safe to move jQuery to the footer if you're able to avoid problems with certain plugins that improperly use jQuery. Copy the necessary lines from `head.php` to `footer.php` right before `wp_footer()`, then update the `wp_register_script()` calls `scripts.php` to have scripts in the footer by setting the last argument to `true`. It's safe to move jQuery to the footer if you're able to avoid problems with certain plugins that improperly use jQuery. Copy the necessary lines from `head.php` to `footer.php` right before `wp_footer()`, then update the `wp_register_script()` calls `scripts.php` to have scripts in the footer by setting the last argument to `true`.
### template-tags.php
This file contains custom template tags.
`roots_entry_meta()` is used by the [theme templates](templates.md) to return the author byline and post time and date information.
### utils.php ### utils.php
This file contains utility functions used by other files in the theme. This file contains utility functions used by other files in the theme.
@@ -126,4 +111,4 @@ This file registers the custom sidebars and custom widgets. There are two initia
1. Primary Sidebar (used by `templates/sidebar.php`, included from `base.php` within `#sidebar`) 1. Primary Sidebar (used by `templates/sidebar.php`, included from `base.php` within `#sidebar`)
2. Footer (used by `templates/footer.php`) 2. Footer (used by `templates/footer.php`)
The included vCard widget can be used to build additional, custom widgets. The included vCard widget can be used to build additional, custom widgets.

8
doc/templates.md
View File

@@ -19,10 +19,16 @@ The `content-page.php` template is included by page templates in the theme root.
The `content-single.php` template is included by single post templates in the theme root. The `content-single.php` template is included by single post templates in the theme root.
### entry-meta.php
`entry-meta.php` displays the author byline, post time, and date information.
### footer.php ### footer.php
`footer.php` includes the Footer sidebar area and displays the site copyright information. `footer.php` includes the Footer sidebar area and displays the site copyright information.
Also included is the [asynchronous Google Analytics snippet](http://mathiasbynens.be/notes/async-analytics-snippet) from HTML5 Boilerplate if an ID is defined in `config.php`.
### head.php ### head.php
`head.php` includes everything in the `<head>`. `head.php` includes everything in the `<head>`.
@@ -45,4 +51,4 @@ The `content-single.php` template is included by single post templates in the th
### sidebar.php ### sidebar.php
`sidebar.php` includes the Primary Sidebar. `sidebar.php` includes the Primary Sidebar.