Community Documentation

How to turn a Handbook page into embedded documentation

Last updated January 31, 2010. Created by cel4145 on June 8, 2005.
Edited by jhodgdon, AjK, Amazon. Log in to edit this page.

  • Include a link referring to the original handbook page after the links section using the following format : "For more information, read the configuration and customization handbook <a href = "" title = "module page">module page</a>."
  • Submit the finalized text as issues against the "help" component of the Drupal project. Announce this on docs/drupal-dev requesting that developers roll patches. Of course, issue follow-ups can also be used to do tweaking of documentation as well.
  • The t function should enclose the text with single quotes. All single quotes in the content need to be escaped with a backslash.
  • All internal URLs must be replaced with variables %variablename, and be added to an array for the t function.
  • Do not use single or double quotes for emphasis as they are difficult to parse for inserting into the code.

About this page

Audience
Documentation contributors

Archive

Drupal’s online documentation is © 2000-2012 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution-ShareAlike 2.0. PHP code is distributed under the GNU General Public License.
nobody click here