-
Notifications
You must be signed in to change notification settings - Fork 7
How to Use It
Currently, in APL's Admin Dashboard 0.3, majority of the settings are located in one page (Settings->Advanced Post Lists). The Plugin is intended to focus on 3 main tasks. Filter, Design, and Location.
The concept is to create a loop that repeats X amount of times. Much like a basic theme loop to display posts (also know as The Loop), but instead of editing a static piece of code that relies mostly on (static) CSS template files and requiring the knowledge to do so. APL offers a very dynamic way to add/replace post lists and isn't limited to just a few ways to display site content. Which can greatly increase site navigation and linkage.
The plugin does have a bit of a learning curve and requires at least some knowledge in HTML
Located in Settings->Advanced Post Lists, at the top portion of APL's Admin Page, is a makeshift Preset Post List Editor for composing Presets (saved configured post lists). The Editor supplies the Plugin User/Webmaster with the tools to complete two of the main tasks, Sort & Filter web content, and Design the style/template. Inserting/Displaying a Post List, the 3rd main task, will be explain further after creating a preset.
Adding and removing, as well as sorting, web content is controlled by the Filter Settings. Located on the upper portion of the Editor, are many of the settings used to filter Post List content. By utilizing the WP Query, a WP Core Object to querying Posts/Pages, APL is able to use many of the dynamic features, like Custom Post Types & Taxonomies, but some other plugins have been known to store data/content as a WP_Query class. It was intended to be loosely written to allow other content, but is currently not supported towards any specific WP Plugins.
//: # (The UI offers a user friendly method to control WP Query params. The top portion, (Custom) Post Types & Taxonomies, is designed within a jQuery UI Accordion to match much like how WP's Dashboard Sidebar Menu is laid out. Clicking on any other post type will expand that Post Type exposing the Taxonomies and Terms within it. In Page post types, Hierarchy Enabled, the Select Parent drop-down menu will be available to filter Child Pages. )
The top portion, (Custom) Post Types & Taxonomies, is designed within a jQuery UI Accordion to relatively match how WP's Dashboard Sidebar Menu is laid out. Clicking on any other post type will expand that Post Type exposing the Taxonomies and Terms within it.
The idea with the Post Type & Taxonomies, is that all posts and pages belong to only one Post Type. So any filter settings in use within that Post Type remain in that Post Type. As a result, two or more Post Types can use the same Taxonomy with different selected filter/terms, and also prevents unnecessarily displaying posts/pages from different Post Types but with the same Taxonomy.
In Page post types, Hierarchy Enabled, the Select Parent drop-down menu will be available to filter Child Pages.
- Require Taxonomy (within Post Type) - Posts/Pages must have Post Type -> Taxonomy within the Post Type.
- Require Terms (within Post Type & Taxonomy) - Posts/Pages must have All terms selected in Post Type -> Taxonomy.
- Include Terms (within Post Type & Taxonomy from Current Page) - Dynamically adds terms within Post Type -> Taxonomy from the current post/page being viewed.
- Any/All (Terms) - Posts/Pages with any of the terms selected in Post Type -> Taxonomy, or, when Require Terms is selected, Posts/Pages must have all terms selected in Post Type -> Taxonomy.
- (Selected) Terms - Posts/Pages with any or all the Terms Selected within various Post Type -> Taxonomies.
Page Types (Only an option if the Post Type is Hierarchical)
- Select Parent - Children Pages from the selected Page Parent.
Below the Post Type -> Taxonomy Accordion, are other filter settings used to control Preset Post List content. Many of which are WP's built-in filter settings, as well as a few other filter settings that have been added/modified, but both offer a more User Friendly UI to controlling post list content.
- Post status - Displays Published, Private, or Posts/Pages in various status states. Works in conjunction with Perm filter.
- List Amount - Controls the max amount of Posts to display; repeat loop (Design -> List Content) X amount of times.
- Author Filter - Add or Remove posts created by selected Author(s).
- Order by (Sort) - Sort Posts Ascending or Descending in the order Selected.
- Perm - Displays Posts/Pages according to the Permissions the Current Viewer has. If the user/viewer doesn't have the powers to the selected permissions, then no posts will display.
- Ignore Sticky Posts - Prevents Sticky Posts/Pages from displaying at the top of the Post List.
- Exclude Current Post - Prevents the current page from being added to the Post List. Since there is no need to have a link to the same page being viewed.
- Exclude Post by ID - Prevents displaying ID specific posts/pages.
- Exclude Duplicates from Current Post - When viewing multiple Preset Posts Lists, posts/pages from prior Presets are added to an exclude list to prevent the next Preset from displaying the exact same posts/pages.
For more information on the about the settings can be found at APL Admin Dashboard -> Content Sorting & Filtering.
Creating and editing a style is controlled by the Design Editor/Template. Located on the lower portion of the of the Editor (above the saved Preset Table), are four text boxes that are labeled Empty Message, Before List, List Content, and After List. Which all comes together to form a template for a loop.
Probably considered one of the biggest requirement is knowledge/experience in Web Design, or more specifically, HTML at the very least and CSS. Which is one of the most common languages that works hand in hand when working with websites. However, APL also comes equiped with the capability to also use PHP via Internal Shortcode call function.
When designing a Preset, think of it as a loop that repeats itself X times (List Amount). There is the Before List and After List (Before & After Loop), which is often used to open and close HTML elements or add CSS & JS. The List Content though, is where the design is repeated inside X times, and displays the individual Post/Page content. However, if no Posts/Pages are found, there is the option to add an Empty Message.
Empty Message - Displays if no posts/pages are queried via Filter Settings.
Before List - Before loop.
List Content - The Loop. Internal Shortcodes are available to display content from individual posts/pages.
After List - After Loop.
APL provides Internal Shortcodes inside the List Content for primarily displaying varies parts of an individual Post/Page (Title, Author, Date, Etc.), and also comes with additional features/support for various requests.
For information on the about the settings can be found at APL Admin Dashboard -> Design.
The Design Editor (Before List, List Content, & After List) is basically in an HTML format.
This is the basis for creating designs, and is the format which the text boxes will use.
Tutorial Sites
Like most other HTML files, there is the option to use CSS either by InLine, or IDs and Classes.
Tutorial Sites
PHP - For advanced users who need custom functions.
Tutorial Sites
There are 3 methods to displaying Preset Post Lists.
- Shortcode - Insert Post Lists through Post content
- Widget - Add a Post List to the sidebar.
- PHP Hardcode - If all else fails, there's a PHP method that can be utilized.
Currently located at the bottom of APL's Admin Dashboard. These settings can serve as a global option for various tasks. One feature the Preset Post Lists rely on is the Default Empty Message for displaying if no posts are found. Other options for managing the database for backup and recoveries can also be found in this area.