Hoping for a more robust "include page" or "include excerpt"

Dylan Maxwell

I'm streamlining docs for my team with templates.
I'm struggling with the Include page and Include excerpt tools

There are two three principles at play here. 

1. Docs should be simple to author (i.e. not overly long or complex with nested macros)
2. Docs should preserve commenting functionality
3. The source of the doc content should be clear and accessible

My issues are these

1. any "include" prevents commenting on the source
2. linking the "include" is a several step process
3. "include excerpt" will only use the first excerpt

My solutions

1. An "include children" macro. which will click through to the child page. Each child page can be parented to automatically add to the parent
2. the "Include page" should have an option to click through to the original location
3. the "include excerpt" should have a variable Key to call a specific excerpt from the page rather than just the first one
4. all  "include ..." macros should be combined to one macro to allow adaptability.
   
   
   

Thanks for considering the above.

 

 

Nic Brough -Adaptavist-

Welcome to the Atlassian Community!

Just to run over the solutions

1. I assume you don't mean "child page" - an include macro can draw in any page, not just children of the current page?
2. Yes, I know what you mean, it would be nice to be able to quickly jump to the source, my preference here would be to have it as a third option when you highlight some text  (so "create Jiras | comment | move to source page").  And I'd like the commenting to work by putting the comment on the source page directly (if the user has permission)
3. See https://marketplace.atlassian.com/search?query=multi-excerpt
4. would make the macro even more unwieldy than they are now