PluginProbe
Weaver Show Posts / 1.7
Weaver Show Posts v1.7
2.0.5 2.0.4 trunk 1.0.1 1.0.2 1.0.3 1.0.4 1.0.6 1.0.7 1.1 1.2 1.2.1 1.2.2 1.2.4 1.3 1.3.1 1.3.1.1 1.3.10 1.3.13 1.3.15 1.3.2 1.3.3 1.3.5 1.3.6 1.3.7 All 37 releases
show-posts / help / help.html

help.html in Weaver Show Posts 1.7, at help/help.html

420 lines 18.7 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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>Weaver Slider</title>
6 <style type="text/css">
7 body {
8 background: #eeeeee;
9 margin: 0; /* it's good practice to zero the margin and padding of the body element to account for differing browser defaults */
10 padding: 10px; /* this centers the container in IE 5* browsers. The text is then set to the left aligned default in the #container selector */
11 color: #000000;
12 text-align: left;
13 font-family: Verdana, Arial, Helvetica, sans-serif;
14 font-size: 10pt;
15 background-color: #ffd;
16 }
17
18 /* everything about each major block on the site - may be mods in some places */
19
20 #container {
21 max-width:800px;
22 background-color: #00CC00;
23 }
24 #mainContent {
25 background-color: #ffc;
26 }
27 .oneColFixCtr #container {
28 max-width: 750px; /* using 20px less than a full 800px width allows for browser chrome and avoids a horizontal scroll bar */
29 background: #FFFFCD;
30 margin: 0 auto; /* the auto margins (in conjunction with a width) center the page */
31 border: 1px solid #000000;
32 text-align: left; /* this overrides the text-align: center on the body element. */
33 }
34 .oneColFixCtr #mainContent {
35 padding: 0 20px; /* remember that padding is the space inside the div box and margin is the space outside the div box */
36 font-size:12px;
37 }
38 /* layouts for layout boxes */
39 .layoutbox {
40 width:700px;
41 text-align:center;
42 margin:0 25px;
43 }
44 .l_layout {
45 display:block;
46 width:140px;
47 height:110px;
48 float:left;
49 margin-right:10px;
50 margin-bottom:10px;
51 display:inline;
52 border:1px solid #888;
53 color:black;
54 text-align:center;
55 font:15px arial, sans-serif;
56 }
57 .l_layout span {
58 display:block;
59 }
60 .l_header {
61 width:140px;
62 height:20px;
63 background:#CCF;
64 line-height:20px;
65 }
66 .l_content {
67 width:100px;
68 height:70px;
69 background:beige;
70 float:left;
71 display:inline;
72 line-height:70px;
73 }
74 .l_contentcenter {
75 width:60px;
76 height:70px;
77 background:beige;
78 float:left;
79 display:inline;
80 line-height:70px;
81 }
82 .l_content2 {
83 width:80px;
84 height:70px;
85 background:beige;
86 float:left;
87 display:inline;
88 line-height:70px;
89 }
90 .l_contentw {
91 width:140px;
92 height:70px;
93 background:beige;
94 float:left;
95 display:inline;
96 line-height:70px;
97 }
98 .l_stdbar {
99 width:40px;
100 height:70px;
101 float:left;
102 display:inline;
103 }
104 .l_widebar {
105 width:60px;
106 height:70px;
107 float:left;
108 display:inline;
109 }
110 .l_righttop {
111 width:40px;
112 height:20px;
113 background:#FE8;
114 float:left;
115 display:inline;
116 line-height:20px;
117 }
118 .l_righttopwide {
119 width:60px;
120 height:20px;
121 background:#FE8;
122 float:left;
123 display:inline;
124 line-height:20px;
125 }
126 .l_rightup {
127 width:40px;
128 height:25px;
129 margin:0;
130 background:#FAA;
131 float:left;
132 display:inline;
133 line-height:25px;
134 }
135 .l_rightright {
136 width:40px;
137 height:50px;
138 margin:0;
139 background:#FAA;
140 float:left;
141 display:inline;
142 line-height:50px;
143 }
144 .l_rightdown {
145 width:40px;
146 height:25px;
147 margin:0;
148 background:#AFA;
149 float:left;
150 display:inline;
151 line-height:25px;
152 }
153 .l_leftleft {
154 width:40px;
155 height:70px;
156 margin:0;
157 background:#AFA;
158 float:left;
159 display:inline;
160 line-height:70px;
161 }
162 .l_leftshort {
163 width:30px;
164 height:50px;
165 margin:0;
166 background:#AFA;
167 float:left;
168 display:inline;
169 line-height:50px;
170 }
171 .l_skinny {
172 width:30px;
173 height:50px;
174 margin:0;
175 background:#FAA;
176 float:left;
177 display:inline;
178 line-height:50px;
179 }
180 .l_footer {
181 clear:left;
182 width:140px;
183 height:20px;
184 background:#DDF;
185 color:#000;
186 line-height:20px;
187 }
188 h4 {
189 font-weight: bold;
190 font-style:italic;
191 color: #000066;
192 text-decoration: underline;
193 }
194 h3 {
195 font-size: medium;
196 font-weight: bold;
197 color: #000066;
198 text-decoration: underline;
199 }
200 h2 {
201 font-size: large;
202 font-weight: bold;
203 color: #000066;
204 text-decoration: underline;
205 margin-top: 40pt;
206 }
207 h1 {
208 font-size: x-large;
209 font-weight: bold;
210 color: #000066;
211 text-decoration: underline;
212 }
213 .codebox {
214 font-family: "Courier New", Courier, monospace;
215 font-size: 10px;
216 font-style: normal;
217 background-color: #E8E8E8;
218 margin: 10px;
219 padding: 4px;
220 border: 1px solid #333333;
221 color: #000000;
222 width: 80%;
223 }
224 .attrs {
225 font-family: Arial, Helvetica, sans-serif;
226 font-size: 10pt;
227 color:#000000;
228 text-decoration: none;
229 }
230 .css {
231 font-family: "Courier New", Courier, monospace;
232 font-size: 9pt;
233 font-style: normal;
234 }
235 .box {
236 color: #000000;
237 text-decoration: none;
238 margin: 5px;
239 padding: 5px;
240 border: thin solid #000000;
241 }
242 .nospace {
243 margin-top: 5px;
244 margin-bottom: 5px;
245 }
246 .style3 {
247 font-family: "Courier New", Courier, monospace
248 }
249 .style4 {
250 font-family: monospace
251 }
252 .style6 {
253 color: #990000;
254 font-style: italic;
255 }
256 .style7 {
257 color: #CC3300;
258 font-weight: bold;
259 }
260 .code1 {
261 font-family: "Courier New", Courier, monospace;
262 font-size: 14px;
263 font-style: italic;
264 }
265 .red-highlight {
266 color: #CC3300;
267 }
268 </style>
269 </head>
270 <body class="oneColFixCtr">
271 <div id="container">
272 <div id="mainContent"> <a name="top" id="top"></a>
273 <h2><b>Weaver Plugin Documentation<br />
274 Weaver Show Posts<br />
275 Version 1.2</b></h2>
276 <p>This document has information about <strong>Weaver Show Posts</strong>. This plugin allows you to show selected posts anywhere on your site that you can use a shortcode.</p>
277 <p><strong>Important Note:</strong> This plugin was formerly called <em>ATW Show Posts</em>. The name has
278 been changed to <em>Weaver Show Posts</em> to tie it in to our other plugins and themes. There is no functional
279 difference between the old and new versions. To preserve compatibility, many classes will retain their
280 previous ".atw-class-name" naming conventions.</p>
281 <h4>Table of Contents</h4>
282 <ul style="line-height:1.7em;">
283 <li><a href="#summary"><strong>Plugin Summary</strong></a></li>
284 <li><strong><a href="#admin_page">Weaver Posts and Slider Admin Page</a></strong></li>
285
286 <li><strong><a href="#showposts">[show_posts] Shortcode</a></strong></li>
287
288 <li><a href="#add_to_sidebar" title="Add to content or sidebar"><strong>How To Add Shortcodes to Your Content or a Sidebar</strong></a></li>
289 </ul>
290 <h2><a name="summary" id="summary"></a>Plugin Summary </h2>
291 <p>The <em>Weaver Show Posts</em> plugin allows you to show posts and posts with a custom post type anywhere your theme supports shortcodes. You can specify which posts will be displayed using an interactive filter design page.</p>
292 <p><em>Weaver Show Posts</em> has a companion plugin. The <em>Weaver Show Sliders</em> plugin allows you to create sliders and slide shows to display images and posts using a shortcode. You can use the Show Posts filter options to specify which posts or posts with images will be used by the slider. Can also specify an images show using the standard WordPress Media Library Create Gallery interface.</p>
293 <p>The <em>Show Posts</em> plugin is a stand-alone plugin, and can be installed and used independently of the <em>Show Sliders</em> plugin. The <em>Show Sliders</em> Plugin <em>requires</em> the <em>Show Posts</em> plugin to work.</p>
294 <h2><a name="admin_page" id="admin_page"></a>Weaver Posts and Slider Admin Page</h2>
295 <p>The administrative interfaces for <em>Weaver Show Posts</em> and its companion, <em>Weaver Show Sliders</em> will be added as a menu item on the Dashboard Menu. If you have just the Show Posts plugin installed, then the menu will be called <em>Weaver Show Posts</em>. If you have both plugins, the menu is called <em>Weaver Posts/Slider</em>, with an additional Dashboard menu called <em>Slider Posts</em> used to define custom pages for your sliders.</p>
296 <h4>Using Shortcodes</h4>
297 <p>Shortcodes are an important part of WordPress. They allow you to insert a shortcode - a named entity surrounded by [square brackets] anywhere into your pages and posts. The [show_posts] shortcodes makes it easy by adding an &quot;Add [show_posts]&quot; button above the icon bar in the Page and Post editor.</p>
298 <p>You can also insert the shortcode anywhere else that a theme, plugin, or widget area supports shortcodes. Note that by default, the standard Text Widget does not support shortcodes. Some themes and plugins extend the Text Widget so it supports shortcodes. If your theme doesn't do that, you can check the option at the bottom of the<em> Weaver Show Posts</em> admin tab to add shortcode support to the standard Text Widget.</p>
299 <h2><a name="showposts" id="showposts"></a><strong>[show_posts] Shortcode</strong></h2>
300 <p> The [show_posts] shortcode is a very powerful tool for displaying posts from within your pages or from a text widget. Among other possibilities, it can be used to get a magazine style layout on your pages. This shortcode is intended to display a relatively small number of selected posts. </p>
301 <p>Which posts are displayed are controlled by the filtering options set on the <em>Filters</em> tab, or provided as parameters of the shortcode. Below is a summary of all parameters, shown with default values. You don't need to supply every
302 option when you add the [show_posts] to your own content. There may seem to be an overwhelming set of options for this shortcode, but it gives you many options for displaying specific posts within a static page. </p>
303 <h3>Defining a Filter</h3>
304 <p>When WordPress displays posts, whether that be on the standard blog page; an archive type page such as categories, tags, dates, or the like; or the posts displayed by<strong> [show_posts]</strong>, it uses a set of filter specifications to select which posts to display in a specific order. For example, the standard blog page will show all posts displayed in descending date order, with sticky posts shown first. A category archive (like categories displayed from the standard WordPress Categories Widget) will show only posts from a specific category.</p>
305 <p>The Weaver <strong>[show_posts</strong>] shortcode will display whatever posts you want to specify. WordPress supports all sorts of options for selecting posts, and the Show Posts <em>Filter</em> tab makes it easy specify just which posts you want displayed.</p>
306 <p>You can define as many different filters that you need. You create and name each Filter in the <em>Filters</em> &quot;Select Filter&quot; box. The rest of the <em>Filters</em> tab lets you set different display and post selection options.</p>
307 <h3>Filter Display Options - Theme Interaction</h3>
308 <p>By default,<em> Weaver Show Posts</em> will normally use its own simple layout of posts. There is typically some interaction with the native theme styling - titles, content fonts, images, etc - but the default will usually not look too bad. If used with the Weaver II or Weaver Xtreme themes (themes developed by the author of this plugin), posts will be displayed using the native Weaver II or Weaver Xtreme display functions by default. Weaver Show Posts can also use the native post display functions of many other themes.</p>
309 <p>There are several options to control how each post is displayed. The normal elements of any post includes the post title; post meta information such as date, author, categories, tags, and featured image; and the main post content displayed as the full post or an excerpt. There are options to display or hide each of these elements. The display/hide option work for the built-in post display functions and the Weaver II or Weaver Xtreme native post displays, but <em>not</em> the native post display functions supported by some themes.</p>
310 <p>To summarize, the [show_posts] can display each post using one of three methods: its own built-in post display function, the native post display function used by the Aspen, Weaver II, or Weaver Xtreme, or the native post display function used by many (but not all) WordPress themes. In the latter two cases, post will be displayed so that they match other posts displayed by your theme. You can select which of these methods is used to display posts.</p>
311 <p> The option to use your theme's native display will not be included unless the theme has a file called <span class="css">content.php.</span> For themes that have this function (over 50% do), most will display posts from [show_posts] nearly the same as they display standard blog posts. However, some themes will have glitches and not give satisfactory display. You should experiment with that setting to see if you get the results you want.</p>
312 <p>In any event, you can use the plugin's built-in post display function, and usually get very satisfactory results. The plugin contains a tab called <em>Custom CSS</em> that can be used to provide custom CSS styling to help the built-in post display better match your theme's native post display. These are the classes used by the built-in post display:</p>
313 <ul>
314 <li><strong>.atw-show-posts</strong> - wraps each post</li>
315 <li><strong>.atw-entry-title a</strong> - the title (h2 a)</li>
316 <li><strong>.atw-entry-meta</strong> - top meta info line</li>
317 <li><strong>.atw-entry-header</strong> - wraps title + meta</li>
318 <li><strong>.atw-featured-image</strong> - wraps the FI</li>
319 <li><strong>.atw-entry-content</strong> - wraps full content</li>
320 <li><strong>.atw-entry-summary</strong> - wraps excerpt</li>
321 <li><strong>.atw-entry-utility</strong> - wraps bottom meta info line</li>
322 <li><strong>.atw-show-posts .sticky</strong> - sticky posts</li>
323 </ul>
324 <p>Note that the Custom CSS option can be used to provide your own custom CSS Styling for any part of your site - without the need to edit your theme's <span class="css">style.css </span>file (-you should NEVER do that anyway). However, providing information on creating CSS rules is beyond the scope of this documentation. While CSS may seem beyond the level of non-technical WordPress users, there are plenty of tutorials available on the web, and you can add lots of fine tuning to almost any theme with a bit of custom CSS.</p>
325 <h3>Filter Selection Options</h3>
326 <p>The Filters options provided by the plugin are generally descriptive of what they do. From a technical standpoint, they exactly match the options supported by <a href="http://codex.wordpress.org/Class_Reference/WP_Query" alt="WP_Query Codex Entry" target="_blank">WP_Query</a>, the PHP function used by WordPress to determine which posts to display.</p>
327 <p>Technical note: There are a few of the options (Post Type, Categories, ByPost IDs) that are often needed by [show_posts], but don't have an exact equivalent in WP_Query, but are manipulated by the plugin to the appropriate values needed internally. But note that there is one option, &quot;Custom WP_Query Args&quot;, that allows you to specify many of the possible WP_Query args not included in the <em>Filters</em> tab. For security and technical reasons, any args requiring an &quot;array(...)&quot; value is not supported by this option.</p>
328 <p>You can't mess up your WordPress database or any other content by experimenting will all these options. So feel free to play with all the options to see just how flexible the <em>Filters</em> tab is for selecting posts to display.</p>
329 <h3>Summary</h3>
330 <p> The Weaver <code>[show_posts]</code> shortcode allows you to display posts on your pages or in a text widget
331 in the sidebar. You can specify a large number of filtering options to select a specific set of posts to show. </p>
332 <p> The recommended way to display posts is to specify all the filter selection options on the <em>Filter</em> tab, and use the <strong>[show_posts filter=filter-name]</strong> form of the shortcode. You can also specify the options manually. </p>
333 <p>&nbsp;</p>
334 <h4>Summary of all parameters for [show_posts] shortcode, shown with default values:</h4>
335 <table style="padding-left:25px;">
336 <tr>
337 <td>cols=1</td>
338 <td>display posts in 1 to 3 columns</td>
339 </tr>
340 <tr>
341 <td>excerpt_length=''</td>
342 <td>Specify the length of automatic post excerpts in words</td>
343 </tr>
344 <tr>
345 <td>posts_per_page=''</td>
346 <td>Number of Posts to Show (Use -1 for all. Default: Settings->Reading value)</td>
347 </tr>
348 <tr>
349 <tr>
350 <td>filter=''</td>
351 <td>use named filter - all other parameters ignored when filter specified </td>
352 </tr>
353 <tr>
354 <td>hide_bottom_info=false</td>
355 <td>hide bottom info line </td>
356 </tr>
357 <tr>
358 <td>hide_featured_image=false</td>
359 <td>hide featured image - FI is displayed by default </td>
360 </tr>
361 <tr>
362 <td>hide_title=false</td>
363 <td>hide the title </td>
364 </tr>
365 <tr>
366 <td>hide_top_info=false</td>
367 <td>hide the top info line </td>
368 </tr>
369 <tr>
370 <td>show=full</td>
371 <td>show: title | excerpt | full | titlelist | title_featured </td>
372 </tr>
373 <tr>
374 <td>show_avatar=false</td>
375 <td>show the author avatar </td>
376 </tr>
377 <tr>
378 <td>more_msg=&quot;New More Message&quot;&nbsp;&nbsp;</td>
379 <td>replacement for Continue Reading excerpt message </td>
380 </tr>
381 <tr>
382 <td>use_paging=false</td>
383 <td>Use paging when displaying multiple posts </td>
384 </tr>
385 <tr>
386 <td>category_name=list</td>
387 <td>list of categories by slug</td>
388 </tr>
389 <tr>
390 <td>post_ids</td>
391 <td>list of posts by IDs</td>
392 </tr>
393 <tr>
394 <td>post_slug</td>
395 <td>single post by specified post slug name</td>
396 </tr>
397 <tr>
398 <td>WP_Query args</td>
399 <td>Any standard <a href="http://codex.wordpress.org/Class_Reference/WP_Query" alt="WP_Query Codex Entry" target="_blank">WP_Query</a> argument (not including those needing array()). <br />
400 Using these options directly requires fairly advanced technical understanding, and is intended for advanced users. </td>
401 </tr>
402 </table>
403 <p><br />
404 You don't need to supply every option when you add the <code>[show_posts]</code> to your own content.
405 You can wrap the parameter values with double or single quota ion marks if you want, but they aren't needed
406 unless the value has a space (e.g., the more_msg example).
407 </p>
408 <h3><a name="add_to_sidebar" id="add_to_sidebar"></a>How To Add Shortcodes to Your Content or a Sidebar</h3>
409 <p>Both Weaver Show Posts and Weaver Show Sliders work through the standard WordPress Shortcode feature. To add a Show Post to your content, insert <strong>[show_posts filter=filter-name]</strong> into a page or post. To insert a slide show, add <strong>[show_slider name=slider-name]</strong>. To make this easier, there are<em> Add [show_posts]</em> and <em>Add [show_slider]</em> buttons above the Page/Post editor icon bar.</p>
410 <p>You can also add these shortcodes to a sidebar using a standard Text Widget. Simply add the shortcode (you can copy the current settings for the shortcode from the version displayed near the top of either the &quot;Show Posts&quot; tab or the &quot;Sliders&quot; tab, then paste them into a Text Widget. Many themes an plugins already add the ability to include shortcodes in the Text Widget, but if you just see the shortcode displayed in the Text Widget when you view your site, open the &quot;Show Posts&quot; tab, and click the option at the bottom to allow the Text Widget to include shortcodes.</p>
411 <p>&nbsp;</p>
412 <p>The Weaver Show Posts Plugin and this document are &copy; 2014-2016, Bruce E. Wampler. <a ref="http://weavertheme.com">Web Site - WeaverTheme.com</a></p>
413 <p>&nbsp;</p>
414 <p>&nbsp;</p>
415
416 </div>
417 </div>
418 </body>
419 </html>
420