Documentation

This documentation is a work in progress.

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

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

1. Download Base Station WordPress theme.
2. Unzip the theme into your wp-content/themes folder.
3. Activate the theme in the WordPress admin under Appearance > Themes.

NOTE: If you plan on customizing this theme in any way, it is highly recommended that you create a child theme so that your changes will not be lost when Base Station is updated. It is simple to do and takes very little time. There is a sample style.css in the child_theme folder to help you get started.

If creating a child theme is more than you need or beyond your abilities, you can still make CSS customizations that will override the default Base Station styles by creating a file called custom.css in the custom folder within the basestation folder. It would live in wp-content/themes/basestation/custom/custom.css.

Base Station 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 “Marketing” 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 “Marketing”. 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 Marketing template for your blog posts page. Choose default or one of the full-width templates.

2. Go to Admin > Appearance > Widgets and assign widgets to “Marketing Page” areas.

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 “Marketing” look.

Base Station supports header images, which display at the top of your site above your content. It supports displaying a single static image, or can display random images on each page load. Configure your header image under Admin > Appearance > Header.

The default header image size is 940px x 288px. These dimensions are defined in the basestation/inc/header-image.php file. You can change them in your child theme by making a copy of this file into your child theme’s inc/ (your_child_theme/inc/header-image.php) directory and making the changes there.

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:

basestation_content_container_class
basestation_sidebar_container_class
basestation_secondary_container_class
basestation_breadcrumb_container_class
basestation_main_navbar_class
basestation_top_navbar_class

basestation_entry_title_text
basestation_posted_on_filter
basestation_post_author_filter

basestation_attachment_size
basestation_search_query
basestation_custom_header_args
basestation_category_archive_meta
basestation_tag_archive_meta

basestation_marketing_page_header_name

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.

Available hooks:

Header hooks

basestation_head
basestation_header_before
basestation_header_inside
basestation_header_after

Content hooks

basestation_content_before
basestation_content
basestation_content_after
basestation_main_before
basestation_main_after
basestation_post_before
basestation_post_after
basestation_post_inside_before
basestation_post_inside_after
basestation_entry_title
basestation_loop_before
basestation_loop_after
basestation_sidebar_before
basestation_sidebar_inside_before
basestation_sidebar_inside_after
basestation_sidebar_after
basestation_archive_page_title
basestation_posted_on
basestation_post_author
basestation_post_categories
basestation_post_tags
basestation_post_comments_link

Footer hooks

basestation_footer_before
basestation_footer_inside
basestation_footer_after
basestation_footer
basestation_marketing_footer_before

You must download the Base Station 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, warning, and error 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" 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: alert, secondary, and success. – If no type is specified, a default color will be used.

Buttons

Tiny Buttons
Small Buttons
Medium Buttons
Large Buttons
Styles

 

Usage:

[button type="success" size="large" style="radius" link="#"]Button Text[/button]

Available types are: normal, secondary, success, and alert. If no type is specified, the “Normal” button is default.
Available sizes are: tiny, small, medium, and large. If no size is specified, the default is medium.
Available styles are: square, radius, and round. If no style is specified, the default is square.

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="745" height="350"]

Parameters: tag, max, width, and height.
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 745. (Example: width=”745″)
height – Specifies the height in pixels of the featured images. The default setting is 350. (Example: height=”350″)

Labels Label and annotate text

Types
Normal Secondary Success Alert

Styles
Regular Radius Round

Usage:

[label type="success" style="radius" ]Important[/label]

Available types are: normal, secondary, success, alert. If no type is specified, the default is Normal.
Available styles are: square, radius, and round. If no style is specified, the default is Square.

Login form Insert a login form in your posts or pages

This shortcode displays a login form where you insert it in your posts or pages. If the user is already logged in, it doesn’t show anything.

Usage:

[loginform redirect="http://www.yoursite.com"]

You can specify the URL to redirect the user after login. If you leave the redirect parameter blank, it returns to the current page after login.

Panels

This is a panel.

 

Usage:

[panel columns="4"]This is a panel.[/panel]

Column can be any number 1-12. Columns default to six “6″ if not specified.

Currently Base Station offers two additional custom widgets and they are the Login Form widget and the Custom Menu: Side Nav 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: Nav List widget was authored by Andrey Savchenko. 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!

Base Station supports internationalization/localization. If you would like to help make Base Station available in your language, please visit the Translate page for more information and to submit your translation.