Uploaded image for project: 'XWiki Platform'
  1. XWiki Platform
  2. XWIKI-13750

Provide a TOC Panel

    XMLWordPrintable

Details

    • New Feature
    • Resolution: Unresolved
    • Major
    • None
    • 7.4
    • Panels
    • None
    • Unknown

    Description

      Over the years there have been several users asking for a TOC Panel. Until XWIKI-13734 it wasn't possible to make one easily.

      Now a quickl implementation is:

      {{velocity}}
#panelheader('Table of Contents')
{{context document="$services.model.serialize($doc.documentReference)" transformationContext="document"}}
{{toc/}}
{{/context}}
#panelfooter()
{{/velocity}}

      Note that an improvement would be to either not display the panel when there's no headings or display a message such as "No headings in current document!".

      Attachments

        Issue Links

          is related to

          New Feature - A new feature of the product, which has yet to be developed. XRENDERING-345 Add an Auto TOC transformation to automatically add a TOC when pages are rendered

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • In Progress
          relates to

          Idea - An idea or wish (something not sure that'll happen but that would be cool) XWIKI-14736 Display/generate the table of contents for any document while reading

          • Major - Major loss of function.
          • Open

          Activity

            People

              Unassigned Unassigned
              vmassol Vincent Massol
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated: