Fix #561 - Use TOC.md for documentation TOC

This commit is contained in:
Ben Word
2012-10-02 18:41:19 -05:00
parent 65c13c6ea9
commit 9e9aa92044
12 changed files with 25 additions and 25 deletions

View File

@@ -13,7 +13,7 @@ Edit `lib/config.php` to enable support for major functionality and to define co
## Documentation ## Documentation
Take a look at the [documentation table of contents](/retlehs/roots/blob/master/doc/README.md). Take a look at the [documentation table of contents](/retlehs/roots/blob/master/doc/TOC.md).
## Features ## Features
@@ -34,7 +34,7 @@ Everyone is welcome to help [contribute](/retlehs/roots/blob/master/CONTRIBUTING
* Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines)) * Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines))
* Suggesting new features * Suggesting new features
* Writing or editing [docs](/retlehs/roots/blob/master/doc/README.md) * Writing or editing [docs](/retlehs/roots/blob/master/doc/TOC.md)
* Writing or refactoring code * Writing or refactoring code
* Fixing [issues](https://github.com/retlehs/roots/issues) * Fixing [issues](https://github.com/retlehs/roots/issues)
* Replying to questions on the [mailing list](http://groups.google.com/group/roots-theme) * Replying to questions on the [mailing list](http://groups.google.com/group/roots-theme)

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Theme activation # Theme activation
@@ -7,7 +7,7 @@ Theme activation is handled by `lib/activation.php`.
After you activate Roots from the WordPress admin you'll be redirected to an activation options page where you can choose to: After you activate Roots from the WordPress admin you'll be redirected to an activation options page where you can choose to:
### Create static front page ### Create static front page
Create a page called Home and set it to be the static front page. This is normally handled from the Reading settings. Create a page called Home and set it to be the static front page. This is normally handled from the Reading settings.

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Clean up # Clean up
@@ -20,13 +20,13 @@ Clean up is handled by `lib/cleanup.php`. Major parts include:
### Root relative URLs ### Root relative URLs
Root relative URLs are enabled from `lib/config.php`. Root relative URLs are enabled from `lib/config.php`.
Return URLs such as `/assets/css/app.css` instead of `http://example.com/assets/css/app.css`. Return URLs such as `/assets/css/app.css` instead of `http://example.com/assets/css/app.css`.
### Wrap embedded media as suggested by Readability ### Wrap embedded media as suggested by Readability
The [Readability article publishing guidelines](http://www.readability.com/developers/guidelines#publisher) suggest wrapping embedded media with a class of `entry-content-asset`. The [Readability article publishing guidelines](http://www.readability.com/developers/guidelines#publisher) suggest wrapping embedded media with a class of `entry-content-asset`.
### Use HTML5 figure and figcaption for images with captions ### Use HTML5 figure and figcaption for images with captions
@@ -53,22 +53,22 @@ Walker_Nav_Menu (WordPress default) example output:
<li id="menu-item-8" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-8"><a href="/">Home</a></li> <li id="menu-item-8" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-8"><a href="/">Home</a></li>
<li id="menu-item-9" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-9"><a href="/sample-page/">Sample Page</a></l <li id="menu-item-9" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-9"><a href="/sample-page/">Sample Page</a></l
Roots_Nav_Walker example output: Roots_Nav_Walker example output:
<li class="menu-home"><a href="/">Home</a></li> <li class="menu-home"><a href="/">Home</a></li>
<li class="menu-sample-page"><a href="/sample-page/">Sample Page</a></li> <li class="menu-sample-page"><a href="/sample-page/">Sample Page</a></li>
If using the Bootstrap top navbar (enabled in `lib/config.php`), the proper markup is added to the items and the depth is restricted to 2 (Bootstrap doesn't support multi-level dropdowns). If using the Bootstrap top navbar (enabled in `lib/config.php`), the proper markup is added to the items and the depth is restricted to 2 (Bootstrap doesn't support multi-level dropdowns).
Instead of the many different active class varities that WordPress usually uses, only `active` is returned on active items. Instead of the many different active class varities that WordPress usually uses, only `active` is returned on active items.
### Remove unnecessary self-closing tags ### Remove unnecessary self-closing tags
Self-closing tags aren't necessary with HTML5. They're removed on: Self-closing tags aren't necessary with HTML5. They're removed on:
1. `get_avatar()` (`<img />`) 1. `get_avatar()` (`<img />`)
2. `comment_id_fields()` (`<input />`) 2. `comment_id_fields()` (`<input />`)
3. `post_thumbnail_html()` (`<img />`) 3. `post_thumbnail_html()` (`<img />`)
### Don't return the default description in the RSS feed if it hasn't been changed ### Don't return the default description in the RSS feed if it hasn't been changed

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Extend and customize Roots # Extend and customize Roots
Here is some useful advice for how you can make your project with Roots even better. Here is some useful advice for how you can make your project with Roots even better.

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Frequently asked questions # Frequently asked questions

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Theme library # Theme library
@@ -65,7 +65,7 @@ This file is a placeholder for you to put in [custom post types](http://codex.wo
### scripts.php ### scripts.php
This file handles all of the CSS and JavaScript. This file handles all of the CSS and JavaScript.
### sidebar.php ### sidebar.php
@@ -80,7 +80,7 @@ Stylesheets are enqueued in the following order:
3. `/theme/assets/css/app.css` 3. `/theme/assets/css/app.css`
4. `/child-theme/style.css` (if a child theme is activated) 4. `/child-theme/style.css` (if a child theme is activated)
`app.css` should be used for your site specific styling. `app.css` should be used for your site specific styling.
If you're using LESS, make sure you compile the files to the proper locations: If you're using LESS, make sure you compile the files to the proper locations:
@@ -100,7 +100,7 @@ jQuery is loaded in `head.php` using the same method from HTML5 Boilerplate: gra
`plugins.js` contains a minified version of all the latest Bootstrap plugins. `plugins.js` contains a minified version of all the latest Bootstrap plugins.
Learn about `plugins.js` and `main.js` in the HTML5 Boilerplate [JavaScript docs](https://github.com/h5bp/html5-boilerplate/blob/master/doc/js.md). Learn about `plugins.js` and `main.js` in the HTML5 Boilerplate [JavaScript docs](https://github.com/h5bp/html5-boilerplate/blob/master/doc/js.md).
##### jQuery in the footer ##### jQuery in the footer

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Recommended Plugins # Recommended Plugins
@@ -10,7 +10,7 @@ table of contents](README.md)
| [**WordPress SEO**](http://yoast.com/wordpress/seo/) | Yoast's all in one SEO solution: titles, meta descriptions, XML sitemaps, breadcrumbs & more. | [**WordPress SEO**](http://yoast.com/wordpress/seo/) | Yoast's all in one SEO solution: titles, meta descriptions, XML sitemaps, breadcrumbs & more.
| [**WP Super Cache**](http://wordpress.org/extend/plugins/wp-super-cache/) | WP Super Cache is a static caching plugin that generates HTML files. | [**WP Super Cache**](http://wordpress.org/extend/plugins/wp-super-cache/) | WP Super Cache is a static caching plugin that generates HTML files.
| [**W3 Total Cache**](http://wordpress.org/extend/plugins/w3-total-cache/) | Improve site performance and user experience via caching. | [**W3 Total Cache**](http://wordpress.org/extend/plugins/w3-total-cache/) | Improve site performance and user experience via caching.
| [Analytics 360](http://wordpress.org/extend/plugins/analytics360/) | Pull Google Analytics and MailChimp data directly into your dashboard. | [Analytics 360](http://wordpress.org/extend/plugins/analytics360/) | Pull Google Analytics and MailChimp data directly into your dashboard.
| [Custom Metaboxes & Fields](https://github.com/jaredatch/Custom-Metaboxes-and-Fields-for-WordPress) | Easily create metaboxes with custom fields. | [Custom Metaboxes & Fields](https://github.com/jaredatch/Custom-Metaboxes-and-Fields-for-WordPress) | Easily create metaboxes with custom fields.
| [Front-end Editor](http://scribu.net/wordpress/front-end-editor) | A WordPress plugin that enables "edit in place" functionality on your site. | [Front-end Editor](http://scribu.net/wordpress/front-end-editor) | A WordPress plugin that enables "edit in place" functionality on your site.
| [Options Framework](https://github.com/devinsays/options-framework-plugin) | An Options Panel Framework to help speed theme development. | [Options Framework](https://github.com/devinsays/options-framework-plugin) | An Options Panel Framework to help speed theme development.

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Rewrites # Rewrites
@@ -27,7 +27,7 @@ First remove the `if` statement that wraps everything, since if you're not on Ap
rewrite ^/plugins/(.*)$ /wp-content/plugins/$1 last; rewrite ^/plugins/(.*)$ /wp-content/plugins/$1 last;
break; break;
} }
### Lighttpd ### Lighttpd
url.rewrite-once = ( url.rewrite-once = (

View File

@@ -1,11 +1,11 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Theme templates # Theme templates
### comments.php ### comments.php
The comments template wraps each comment in an `<article>` and the vCard microformat is used for comment author information. The comments template wraps each comment in an `<article>` and the vCard microformat is used for comment author information.
### content.php ### content.php

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Usage # Usage

View File

@@ -1,5 +1,5 @@
[Roots Theme homepage](http://www.rootstheme.com/) | [Documentation [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation
table of contents](README.md) table of contents](TOC.md)
# Theme wrapper # Theme wrapper