Title: Contributor Handbooks
Author: Samuel Sidler
Published: April 1, 2015
Last modified: September 23, 2016

---

# Contributor Handbooks

## In this article

 * [Setup](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#setup)
 * [Menu](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#menu)
 * [Shortcodes](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#shortcodes)
 * [Naming](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#naming)

[↑ Back to top](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#wp--skip-link--target)

Contributor handbooks are located on make.wordpress.orgWordPress.org The community
site where WordPress code is created and shared by the users. This is where you 
can download the source code for WordPress core, plugins and themes as well as the
central location for community conversations and organization. [https://wordpress.org/](https://wordpress.org/)/[
team-name]/handbook/. Each team can opt-in to having a handbook.

## 󠀁[Setup](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#setup)󠁿

To setup a contributor handbook, a network admin needs to do the following:

 1. Enable the Handbook pluginPlugin A plugin is a piece of software containing a group
    of functions that can be added to a WordPress website. They can extend functionality
    or add new features to your WordPress websites. WordPress plugins are written in
    the PHP programming language and integrate seamlessly with WordPress. These can
    be free in the WordPress.org Plugin Directory [https://wordpress.org/plugins/](https://wordpress.org/plugins/)
    or can be cost-based plugin from a third-party..
 2. Create a new Handbook page called “Handbook” with the slug of “handbook.”
 3. Go into Settings -> Permalinks and press the “Save Changes” button.

The handbook is now (mostly) setup and new pages will be visible to users.

## 󠀁[Menu](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#menu)󠁿

The handbook sidebarSidebar A sidebar in WordPress is referred to a widget-ready
area used by WordPress themes to display information that is not a part of the main
content. It is not always a vertical column on the side. It can be a horizontal 
rectangle below or above the content area, footer, header, or any where in the theme.(
menu) is auto-generated based on the “Order” and “Parent” attributes of each handbook
page. New published pages appear automatically in the sidebar.

In the past, the handbook sidebar was a custom menu and some sites still opt-in 
to this method, though it is not recommended. In this world, new pages in handbooks
would not automatically show. Initially, a new menu needs to be created. Creating
the menu required the following:

 1. Go to Appearance -> Menus and “create a new menu” called “Table of Contents” (or
    anything, really).
 2. Add any Handbook page to the menu and save the menu.
 3. Go to Appearance -> Widgets. In the Handbook widgetWidget A WordPress Widget is
    a small block that performs a specific function. You can add these widgets in sidebars
    also known as widget-ready areas on your web page. WordPress widgets were originally
    created to provide a simple and easy-to-use way of giving design and structure 
    control of the WordPress theme to the user. area, add a Custom Menu and select 
    the the “Table of Contents” menu.
 4. Name this menu whatever you’d like to show in the headerHeader The header of your
    site is typically the first thing people will experience. The masthead or header
    art located across the top of your page is part of the look and feel of your website.
    It can influence a visitor’s opinion about your content and you/ your organization’s
    brand. It may also look different on different screen sizes. above the sidebar.
    Often, teams choose “Chapters.”

## 󠀁[Shortcodes](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#shortcodes)󠁿

When enabled, the handbook plugin offers a few shortcodes that can be used throughout
the site. These shortcodes (described below) can be used anywhere on the site and
are not limited to the handbook CPT. **All of these shortcodes require closing tags.**

The [ info ] shortcodeShortcode A shortcode is a placeholder used within a WordPress
post, page, or widget to insert a form or function generated by a plugin in a specific
location on your site. is used to display informational messages.

Use the [ tip ] shortcodeShortcode A shortcode is a placeholder used within a WordPress
post, page, or widget to insert a form or function generated by a plugin in a specific
location on your site. to highlight tips.

The [ alert ] shortcodeShortcode A shortcode is a placeholder used within a WordPress
post, page, or widget to insert a form or function generated by a plugin in a specific
location on your site. is for alerting readers to important messages.

When something is particularly precarious, use the [ warning ] shortcodeShortcode
A shortcode is a placeholder used within a WordPress post, page, or widget to insert
a form or function generated by a plugin in a specific location on your site..

Tutorial lessons should use the [ tutorial ] shortcodeShortcode A shortcode is a
placeholder used within a WordPress post, page, or widget to insert a form or function
generated by a plugin in a specific location on your site., but should continue 
on from previous tutorials.

## 󠀁[Naming](https://make.wordpress.org/meta/handbook/tutorials-guides/contributor-handbooks/?output_format=md#naming)󠁿

In some cases, your site might not want to use the standard handbook name. Currently,
we use the meta team’s name for the handbook name. For example, the “core” team’s
handbook is called the “Core Handbook.” However, this doesn’t make as much sense
for the polyglots team. The handbook name is changeable using the following steps:

 * Go to Settings –> General for the site you want to change.
 * Find the option for “Handbook name” on that page and change it.
 * Save Changes.

Easy, right? Yay!

First published

April 1, 2015

Last updated

September 23, 2016

[  Previous: Contributing With Git](https://make.wordpress.org/meta/handbook/tutorials-guides/contributing-with-git/)

[  Next: Feature Plugin Treatment](https://make.wordpress.org/meta/handbook/tutorials-guides/feature-plugin-treatment/)