Documentation

This is the Documentation (Manpages) for the ZipGun WordPress theme and it’s features.

Theme Options

Theme Options (dashboard link)

The Theme Options menu item on the admin dashboard

The theme options page can be viewed and set once the theme is installed and activated. To access these options from the admin Dashboard, navigate to Appearance > Theme Options.

Theme Options (WP-Admin bar)

The Theme Options link on the WP-Admin bar

You can also access the theme options from the public facing site by using the Admin bar and selecting Theme Options (if you have this functionality enabled).

 

The theme options are organized according to their functionality into the following sections (click to jump to a section):

  • Layout – How the site is displayed to visitors
  • Breadcrumbs – “Breadcrumb” navigation links
  • Custom Post Types – The theme-specific post types
  • Entries – Layout for posts and pages
  • Search – Search form behavior and appearance
  • Meta – Meta data inclusion and organization
  • Shortcodes – Enable theme-specific shortcodes

Layout

  • Add “Theme Options” link to Admin Bar

    • Default: True
    • Add a links to the ”Theme Options“ page on the administrator’s Admin Bar.
  • Title separator

    • Default: »
    • The character used to separate information in the title of the page (inside the <title> tag).

Breadcrumbs

Example breadcrumb navigation links

Example breadcrumb navigation links

  • Breadcrumb Separator

    • Default:
    • The character used to separate the “breadcrumb” navigation links displayed at the top of the page under the site title.
  • Show “Home” Breadcrumb?

    • Default: True
    • Start the list of breadcrumbs with a “Home” link (when not on the homepage)?
  • Allow the Uncategorized Category?

    • Default: False
    • Show the default category link in breadcrumbs (if it is the only category or if no categories)?
    • Note: A posible point of confusion: the theme grabs the name of the default/fallback category as set by the site (the category with and ID of 1). By default, this category is titled “Uncategorized”, but if you renamed it, it will display that title for this option instead.
  • Breadcrumb Category

    • Default: Most Posts
    • What criteria should be used to select the category for the breadcrumbs if a post in filed in multiple categories and no main category has been set in the post meta?
    • The breadcrumbs only display 1 category, so in posts with multiple categories, only 1 will be used as a breadcrumb. There are 3 sorting methods to resolve this conflict:
      1. Use the category with the most posts
      2. Use the category order (lowest cat_ID)
      3. Use first alphabetically

      Additionally, you can set a “Primary Category” in individual posts. The idea is to use the most important category, so generally the “most posts” option is the most useful.

  • Minimum Breadcrumbs Required

    • Default: 1
    • Not counting “Home” and the current page, how many breadcrumbs must be present to show the trail?
    • Leaving this option blank or setting it to zero means always show the breadcrumbs regardless of how many there are.

Custom Post Types

  • Enable “Manual” Post Type

    • Default: False
    • A support focused post type for explaining anything that might need a manual.

Entries

  • Date on Post

    • Default: Published
    • When displaying a date for a post, use the date it was first published, or the date it was last updated? The label will also change between ldquo;Published” and ldquo;Updated” to avoid confusion.

Search

  • Show Top Search Bar

    • Default: True
    • Display a search form on the top right near the navigation menu?
  • Allow Blank Searches

    • Default: True
    • Searches submitted with no search text we be handled by the search page instead of the default behavior (which is being treated as a request for the index/homepage).
  • Searchable Post Types

    • Default: (Publicly Searchable Post Types)
    • What post types should be searched if none is specified? Each post type has the variables public and publicly_queryable set to determine if it should be displayed in searches, but the theme allows you to include post types that have publicly_queryable set to false, but only if it is a public post type (to avoid possible security issues).

Meta

  • Cleanup the <head> code?

    • Default: True
    • Optimizes the HTML head code by grouping meta, style, and script information together. It also removes unnecessary tags and reorganizes the entire <head> tags so that it looks much cleaner and loads faster.
      • Example without optimization:
        <meta name='robots' content='noindex,nofollow' />
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=2">
        <link rel='stylesheet' id='admin-bar-css' href='http://zipgun.shinraholdings.com/wp-includes/css/admin-bar.css?ver=3.4.2' type='text/css' media='all' />
        <link rel='stylesheet' id='core-css' href='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/style.css?ver=3.4.2' type='text/css' media='all' />
        <link rel='stylesheet' id='syntax-default-css' href='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/css/syntax-default.css?ver=3.4.2' type='text/css' media='all' />
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-includes/js/jquery/jquery.js?ver=1.7.2'></script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/sf.js?ver=1.4.8'></script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/ss.js?ver=1.4.8'></script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/syntax/shCore.js?ver=3.0.83'></script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/init.js?ver=3.4.2'></script>
        <link rel="EditURI" type="application/rsd+xml" title="RSD" href="http://zipgun.shinraholdings.com/xmlrpc.php?rsd" />
        <link rel="wlwmanifest" type="application/wlwmanifest+xml" href="http://zipgun.shinraholdings.com/wp-includes/wlwmanifest.xml" />
        <meta name="generator" content="WordPress 3.4.2" />
        <style type="text/css" media="print">#wpadminbar { display:none; }</style>
        <style type="text/css" media="screen">
        html { margin-top: 28px !important; }
        * html body { margin-top: 28px !important; }
        </style>
        <style type="text/css">#site-title,#site-title a,#site-description,#site-description a{color:#eee;}html,body{background-color: #fafafa;}</style>

      • Example with optimization enabled:
        <meta name='robots' content='noindex,nofollow' />
        <meta name="generator" content="WordPress 3.4.2" /> 
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />  
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=2">
        <link rel='stylesheet' id='admin-bar-css' href='http://zipgun.shinraholdings.com/wp-includes/css/admin-bar.css?ver=3.4.2' type='text/css' media='all' /> <link rel='stylesheet' id='core-css' href='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/style.css?ver=3.4.2' type='text/css' media='all' /> <link rel='stylesheet' id='syntax-default-css' href='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/css/syntax-default.css?ver=3.4.2' type='text/css' media='all' />
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-includes/js/jquery/jquery.js?ver=1.7.2'> </script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/sf.js?ver=1.4.8'> </script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/ss.js?ver=1.4.8'> </script>
        <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/syntax/shCore.js?ver=3.0.83'> </script> <script type='text/javascript' src='http://zipgun.shinraholdings.com/wp-content/themes/zipgun/js/init.js?ver=3.4.2'> </script>
        <style type="text/css">@media print{#wpadminbar{display:none;}}@media screen{html{margin-top:28px !important;}* html body{ margin-top:28px !important;}}#site-title,#site-title a,#site-description,#site-description a{color:#eee;}html,body{background-color: #fafafa;}</style>

Shortcodes

  • Permit All Shortcodes in Widgets

    • Default: False
    • Enable shortcode use in the content section of any widget.
  • Enable [code] Shortcode?

    • Default: False
    • Prevents code from being jumbled when saved in the editor and highlights syntax according to programming language (has markup rules for 25+ languages).
    • Usage: [code lang="php"]code_here();[/code]
  • Enable [code] Shortcode in Comments?

    • Default: False
    • Allows only the [code] shortcode to be used by visitors in comments.
    • Note: Giving commenters access to other shortcodes may pose a security risk, but since this shortcode is solely cosmetic, it's okay to allow any user level access to it.


Leave a Reply

Your email address will not be published. Required fields are marked *