|
1
|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> |
|
|
5 |
<title>A guide to the Hybrid Hook Widgets plugin</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" href="readme.css" type="text/css" media="screen" /> |
|
|
8 |
|
|
|
9 |
</head> |
|
|
10 |
<body> |
|
|
11 |
|
|
|
12 |
<h1>A guide to Hybrid Hook Widgets</h1> |
|
|
13 |
|
|
|
14 |
<p><em>Hybrid Hook Widgets</em> is a plugin that creates new widget areas for the <em>Hybrid</em> theme and attaches them to the theme's action hooks. Basically, it allows you to add widgets pretty much anywhere.</p> |
|
|
15 |
|
|
|
16 |
<p>Typically, to add extra stuff to the theme, you must use one of <em>Hybrid's</em> action hooks. This can be quite confusing to some users. This plugin was created mainly for those users without much <acronym title="Extensible Hypertext Markup Language">XHTML</acronym> and <acronym title="Hypertext Preprocessor">PHP</acronym> knowledge. It allows them to take advantage of <em>Hybrid's</em> advanced hook system without the need to understand how it works. Of course, even advanced users can take advantage of this, especially when dealing with client work.</p> |
|
|
17 |
|
|
|
18 |
<h2>How to install the plugin</h2> |
|
|
19 |
|
|
|
20 |
<ol> |
|
|
21 |
<li>Uzip the <code>hybrid-hook-widgets.zip</code> folder.</li> |
|
|
22 |
<li>Upload the <code>hybrid-hook-widgets</code> folder to your <code>/wp-content/plugins</code> directory.</li> |
|
|
23 |
<li>In your WordPress dashboard, head over to the <em>Plugins</em> section.</li> |
|
|
24 |
<li>Activate <em>Hybrid Hooks Widgets</em>.</li> |
|
|
25 |
</ol> |
|
|
26 |
|
|
|
27 |
<h2>Using the plugin</h2> |
|
|
28 |
|
|
|
29 |
<p>This plugin is pretty simple to use. Just head over to your <em>Widgets</em> panel while in your WordPress admin. You'll notice several additional widget areas for you to use. When a widget is placed within a particular widget area, it will show on the front end of your site:</p> |
|
|
30 |
|
|
|
31 |
<ul> |
|
|
32 |
<li> |
|
|
33 |
<strong>Hook: Before HTML</strong><br /> |
|
|
34 |
Located just inside the <code><body></code> tag and before all other content. |
|
|
35 |
</li> |
|
|
36 |
<li> |
|
|
37 |
<strong>Hook: After HTML</strong><br /> |
|
|
38 |
Located just before the closing <code></body></code> tag and after all other content. |
|
|
39 |
</li> |
|
|
40 |
<li> |
|
|
41 |
<strong>Hook: Before Header</strong><br /> |
|
|
42 |
Located before the theme's header area. |
|
|
43 |
</li> |
|
|
44 |
<li> |
|
|
45 |
<strong>Hook: Header</strong><br /> |
|
|
46 |
Located within the theme's header area. |
|
|
47 |
</li> |
|
|
48 |
<li> |
|
|
49 |
<strong>Hook: After Header</strong><br /> |
|
|
50 |
Located after the theme's header area. |
|
|
51 |
</li> |
|
|
52 |
<li> |
|
|
53 |
<strong>Hook: Before Container</strong><br /> |
|
|
54 |
Located just before the main content area. |
|
|
55 |
</li> |
|
|
56 |
<li> |
|
|
57 |
<strong>Hook: After Container</strong><br /> |
|
|
58 |
Located just after the main widget areas (Primary and Secondary). |
|
|
59 |
</li> |
|
|
60 |
<li> |
|
|
61 |
<strong>Hook: Before Footer</strong><br /> |
|
|
62 |
Located before the theme's footer area. |
|
|
63 |
</li> |
|
|
64 |
<li> |
|
|
65 |
<strong>Hook: Footer</strong><br /> |
|
|
66 |
Located within the theme's footer area. |
|
|
67 |
</li> |
|
|
68 |
<li> |
|
|
69 |
<strong>Hook: Before HTML</strong><br /> |
|
|
70 |
Located after the theme's footer area. |
|
|
71 |
</li> |
|
|
72 |
<li> |
|
|
73 |
<strong>Hook: Comment Form</strong><br /> |
|
|
74 |
Located at the end of the comment form. |
|
|
75 |
</li> |
|
|
76 |
</ul> |
|
|
77 |
|
|
|
78 |
<h2>Some notes about usage</h2> |
|
|
79 |
|
|
|
80 |
<p>Because this plugin isn't necessarily supported within the theme or its child themes, there may be some times when things look a little wonky. This is perfectly normal and expected. This is caused by two issues:</p> |
|
|
81 |
|
|
|
82 |
<ol> |
|
|
83 |
<li>No <acronym title="Cascading Style Sheets">CSS</acronym> rules are written specifically for this plugin's widget areas.</li> |
|
|
84 |
<li>The child theme has other features that push the widget area out of view.</li> |
|
|
85 |
</ol> |
|
|
86 |
|
|
|
87 |
<p>The biggest thing here is the <acronym title="Cascading Style Sheets">CSS</acronym>. More than likely, you'll have to write some custom style rules to make the widget areas appear as you'd like. That's just how it is, but diving into your child theme's <code>style.css</code> file beats the heck out of having to dive into both your <code>style.css</code> and <code>functions.php</code> files.</p> |
|
|
88 |
|
|
|
89 |
<p>To read more about the action hooks within the <em>Hybrid</em> theme, please read the <a href="http://themehybrid.com/themes/hybrid/hooks" title="Hybrid theme hooks">hooks reference</a>.</p> |
|
|
90 |
|
|
|
91 |
<h2>Plugin support</h2> |
|
|
92 |
|
|
|
93 |
<p>I run a WordPress community called <a href="http://themehybrid.com" title="Theme Hybrid">Theme Hybrid</a>, which is where I fully support all of my WordPress projects, including plugins. You can sign up for an account to get plugin support for a small yearly fee ($25 <acronym title="United States Dollars">USD</acronym> at the time of writing).</p> |
|
|
94 |
|
|
|
95 |
<p>I know. I know. You might not want to pay for support, but just consider it a donation to the project. To continue making cool, <acronym title="GNU General Public License">GPL</acronym>-licensed plugins and having the time to support them, I must pay the bills.</p> |
|
|
96 |
|
|
|
97 |
<h2>Copyright & license</h2> |
|
|
98 |
|
|
|
99 |
<p><em>Series</em> is licensed under the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html" title="GNU GPL">GNU General Public License</a>, version 2 (<acronym title="GNU General Public License">GPL</acronym>).</p> |
|
|
100 |
|
|
|
101 |
<p>This plugin is copyrighted to <a href="http://justintadlock.com" title="Justin Tadlock">Justin Tadlock</a>.</p> |
|
|
102 |
|
|
|
103 |
<p>2009 © Justin Tadlock</p> |
|
|
104 |
|
|
|
105 |
</body> |
|
|
106 |
</html> |