Documentation

This documentation is a work in progress.

Bootstrap is an extensive toolkit with a ton of features, and you can use pretty much all of them with this theme. For documentation specific to Bootstrap, go here.

  1. Navigation Menus
  2. Front Page
  3. Featured Posts
  4. Filters
  5. Hooks
  6. Shortcodes
  7. Widgets
  8. Translations

Alien Ship does nothing special in regards to the front page. It abides by the settings you have configured in Admin > Settings > Reading. The default WordPress configuration is to show a list of posts.

If you want to have the “Hero” landing page as your home page, here is what you need to do.

1. Create a page called Home (or anything else you like) in Admin > Pages > Add New. On the right side of the “Add New” page, you will see a box entitled “Page Attributes”. In the “Template” dropdown, select “Hero”. Fill out the content in your page and publish it. Optionally, if you want to publish blog posts, create a regular page here called “Blog” or “News” or whatever you want. Do not choose the Hero template for your blog posts page. Choose default or one of the full-width templates.

2. Go to Admin > Appearance > Widgets and assign your widgets to the “Hero Widgets”.

3. Go to Admin > Settings > Reading and set “Front page displays” to “A static page”. For “Front page” select your newly-created “Home” page from the first step above. Optionally, under “Posts page”, assign the page you created in the first step above.

4. Your site should now have that “Hero” look.

The theme includes filters to allow for easy customization of content and structure. This list is sure to grow over time, and some examples of use will be available later.

** This is a work in progress. So that I can stay on top of documentation, I’m adding filters to this list as I add them in my development environment. If you see one listed here that is not in the theme, try downloading the latest beta. If you still don’t see it, you can expect it to be uploaded soon.

Available filters:

alienship_main_navbar_class
alienship_top_navbar_class
alienship_attachment_size
alienship_get_featured_posts
alienship_stacked_pills_menu_args

nav_menu_link_attributes
nav_menu_item_id
nav_menu_css_class

theme_layouts_meta_key
theme_layouts_strings
get_theme_layout
get_post_layout

breadcrumb_trail_args
breadcrumb_trail
breadcrumb_trail_items
breadcrumb_trail_get_bbpress_items

A number of hooks are included in the theme to allow you to easily customize the design and functionality of your site. The names are fairly self-explanatory. If you have any questions, look for them inside the templates to figure out where their output will show up. Note: A lot of hooks were removed in 2.0, in favor of letting you add only what you need.

Available hooks:

alienship_head
alienship_loop_before
alienship_loop_after
alienship_featured_posts_before
alienship_featured_posts_after

*NOTE* You must download the Alien Ship Shortcodes plugin to get this functionality. This allows you the flexibility of changing themes if needed without losing access to your shortcode content.

Alerts Styles for success, info, warning, and danger messages

Congrats!

You won the lottery! Now, if you would kindly write me a check for a few million, we’ll be done here.

Congrats!

You won the lottery! Now, if you would kindly write me a check for a few million, we’ll be done here.

Congrats!

You won the lottery! Now, if you would kindly write me a check for a few million, we’ll be done here.

Congrats!

You won the lottery! Now, if you would kindly write me a check for a few million, we’ll be done here.

Usage:

[alert type="success" close="true" heading="Congrats!"]You won the lottery! Now, if you would kindly write me a check for a few million, we'll be done here.[/alert]

Available types are: success, info, warning, and danger. – If no type is specified, “success” will be used. By default, the close button is not shown. If you want to show it, add close="true" to your shortcode.

Badges Indicators and unread counts

Available options

Name Example Usage
Default 1 [badge]1[/badge]

Buttons

Usage:

[button type="primary" size="lg" link="#"]Button Text[/button]

Available types are: default, primary, success, info, warning, and danger.
Available sizes are: xs, sm, medium, and lg. If no size is specified, the default is medium.

Featured Posts Highlight content practically anywhere

Displays a featured posts image carousel. For more information about featured posts themselves, read the Featured Posts documentation. Note: This shortcode currently doesn’t support the featured posts grid. Support for the grid will come soon.

Usage:

[featured-posts tag="featured" max="3" width="850" height="350"]

Parameters: tag, max, width, height, indicators, and captions.
tag – Posts tagged with this tag will be featured. Default is “featured”. (Example: tag=”featured”)
max – The maximum # of posts to display in the carousel. You must specify an integer. The default is 3. (Example: max=”3″)
width – Specifies the width in pixels of the featured images. The default setting is 850. (Example: width=”850″)
height – Specifies the height in pixels of the featured images. The default setting is 350. (Example: height=”350″)
indicators – Show indicators at the bottom of the slides that indicate the current position of the slideshow. The default setting is true. To disable, set to false. (Example: indicators=”false”)
captions – Show the post titles as captions on each slide. The default setting is true. To disable, set to false. (Example: captions=”false”)

Labels Label and annotate text

Default Primary Success Info Warning Danger

Usage:

[label type="danger"]Danger[/label]

Available types are: default, primary, success, info, warning, and danger.

Panels

This is a panel title

This is the body of the panel. Pretty cool, eh?

This is a primary panel

This is the body of the panel. Pretty cool, eh?

Footer optional

Panels can also have an optional footer, like this one.

This panel has neither a header nor a footer

Usage:

[panel type="success"]This is a panel.[/panel]

Available options:
type – Determines the color of the panel. Options are default, primary, success, info, warning, and danger.
heading – Controls whether a title is displayed or not. Options are true or false. Default is true.
title – Outputs a title if heading=”true”.
body – The text that shows in the body of the panel.
footer – Optionally shows text in a footer.

Wells Subtle inset effect

This is a well.

Usage:

[well]This is a well.[/well]

Currently Alien Ship offers two additional custom widgets and they are the Login Form widget and the Custom Menu: Stacked Pills widget. The Login Form widget was originally authored by Justin Tadlock, and it’s included in this theme with a few small extras and some minor styling adjustments. The Custom Menu: Stacked Pills widget was authored by Andrey Savchenko, and later changed by me to use the Stacked Pills nav component in Bootstrap 3. Go to Admin > Appearance > Widgets to enable them. Be sure to check out all the options available in these widgets. Thanks to Justin and Andrey for creating such nice widgets!

Alien Ship is translation ready, and will let you easily build a theme for use in other languages. The included grunt file has the configuration you need to generate a new POT file for your custom theme. All you have to do is run grunt makepot.