Finished Edit me
A User can include a simple command to automatically build out the list of child pages

User Story

As a Practical ™ Documentation user, I don’t want to maintain lists of links on higher level pages. Instead, I would prefer if the system provided me with a simple command that would allow me to insert an automatic list of nested child pages.

Design Considerations

The sidebar yaml file is the only true authority on the nesting structure (at this time). It should be possible to create an include that loops through the sidebar yaml building out a link-list connecting to all child pages.

Acceptance Criteria

The system will generate the link list from the sidebar yaml, wiht the child page title as the anchor text, and url as the href.

Scenarios

  • Given the following page structure and associated chunk of sidebar yaml:

      - title: This is Page A
        url: /pages/my_product/A.html
        output: web, pdf
        folderitems:
        - title: This is Page B
          url: /pages/my_product/B.html
          output: web, pdf
          folderitems:
        - title: This is Page C
          url: /pages/my_product/c.html
          output: web, pdf
          folderitems:
    
  • When the user types this: { % include child-page-list.html % } on page “A.html”
  • Then the system generates this:
    <ul>
      <li><a href="/pages/my_product/B.html">This is Page B</a></li>
      <li><a href="/pages/my_product/c.html">This is Page C</a></li>
    </ul>