Velocity
  1. Velocity
  2. VELOCITY-604

Document: Allow definition of macro's within parsed files

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 1.4, 1.5
    • Fix Version/s: 1.6
    • Component/s: Documentation
    • Labels:
      None

      Description

      Your documentation at http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html#velocimacro_miscellany has the following snippet -

      "
      Velocimacro Trivia
      -------------------------
      Currently, Velocimacros must be defined before they are first used in a template. This means that your #macro() declarations should come before using the Velocimacros.

      This is important to remember if you try to #parse() a template containing inline #macro() directives. Because the #parse() happens at runtime, and the parser decides if a VM-looking element in the template is a VM at parsetime, #parse()-ing a set of VM declarations won't work as expected. To get around this, simply use the velocimacro.library facility to have Velocity load your VMs at startup.

      Is this likely to change in any forthcoming versions?

      The use case is theme development for Confluence. It would be nice to be able to share some common macro definitions between a number of templates within a theme (i.e. not inlining). And using the velocimacro.library property isn't really an option because themes are dynamically loaded or unloaded.

        Activity

        Hide
        Will Glass-Husain added a comment -

        Thanks, Paul. This is fixed in the forthcoming version 1.6. You can download from svn head and try it out.

        I'm changing this issue to note we need to fix the docs.

        Show
        Will Glass-Husain added a comment - Thanks, Paul. This is fixed in the forthcoming version 1.6. You can download from svn head and try it out. I'm changing this issue to note we need to fix the docs.
        Hide
        Paul Curren added a comment -

        Great, thanks for that.

        Show
        Paul Curren added a comment - Great, thanks for that.
        Hide
        Nathan Bubna added a comment -

        Ok, that section of docs has been updated.

        Show
        Nathan Bubna added a comment - Ok, that section of docs has been updated.

          People

          • Assignee:
            Unassigned
            Reporter:
            Paul Curren
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development