Uploaded image for project: 'XWiki Rendering'
  1. XWiki Rendering
  2. XRENDERING-61

Add ability to have a box drawn around TOC macro by using a TOC macro parameter + ability to position location of TOC macro

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: Rendering in the platform
    • Fix Version/s: None
    • Component/s: Macro - Toc
    • Difficulty:
      Easy
    • Similar issues:
    • GCI categories:
      Code

      Description

      If it's your first Google Code-In task it's highly recommended to start with Become a community member.

      Prerequisites

      • Assign yourself to the Jira issue

      Issue

      We need to make it easy to insert a TOC for a page using one of the following 2 typical use cases:

      Of course the user could use a box macro around the toc macro but 2 issues with this:

      • it's more complex
      • it won't be styled as we want it and the user would need to use the cssClass parameter with a value which is too complex

      Proposal:

      • Add a "box=true" parameter to the TOC macro
      • Add a "floating=left|right" parameter to the TOC macro

      Expected Outcome

      <describe very precisely the success criteria for the task so that the student knows what to achieve and so that any mentor can easily validate the task>

      • The student must commit the changes and create a pull request on https://github.com/xwiki/xwiki-rendering
        • The summary of the Pull Request must have a first line matching the JIRA issue following by a colon and then the title of this issue
        • Add a comment in the jira issue mentioning your pull request and provide a link to it

      Links

      Getting help

      If you have any question you should use the Chat (faster answer, but when there is someone around) or the Forum (more people available, but slower answer).

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              vmassol Vincent Massol
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Date of First Response: