Download & Extend

Book Outline Builder API

This is an API for creating book content outlines. It's similar to the Skeleton module in that it seeks to make outlines reusable but differs in that it's completely for developers. For examples on how to implement this see the ELMS distribution (see elms_id_best_practices and elms_content for complex examples in particular). Right now this is used for course outlines but is generalized to allow for the rapid creation of any outline. Below you will see the API.txt file for how you can implement and modify outlines defined by other projects.

Here is the basic structure:

$outline['YOUR_TEMPLATE_MACHINE_NAME'] = array(
     'title' => 'YOUR TEMPLATE NAME',
      array(
       'type' => '',
       'title' => '',
       'content => '', //optional body content
'format' => '', //optional text input format
'duplicate' => TRUE //or number of times to replicate,
'children' => array(
//SAME STRUCTURE AS ABOVE NOW
)
     ));

--Acceptable values for type, any kind of content type
--@i can be used in the title of something that's going to be duplicated as to where the incemental value should be placed. This is not required.
--duplicate: number of times to duplicate, the loop value can be altered based on criteria, see hook_book_outline_builder_loop_alter.
--children: An array of additional items that make up the full outline

Downloads

Recommended releases

Version Downloads Date Links
6.x-1.0-alpha1 tar.gz (8.77 KB) | zip (9.8 KB) 2012-Jan-29 Notes

Development releases

Version Downloads Date Links
7.x-1.x-dev tar.gz (8.83 KB) | zip (9.82 KB) 2012-May-25 Notes
6.x-1.x-dev tar.gz (8.75 KB) | zip (9.78 KB) 2012-May-25 Notes

Project Information


Maintainers for Book Outline Builder API

  • btopro - 4 commits
    last: 3 days ago, first: 17 weeks ago

Issues for Book Outline Builder API

To avoid duplicates, please search before submitting a new issue.
All issues
Bug reports
nobody click here