Integrate excerpt-include(+) macro with include libraries

Description

It is not possible to use the excerpt-include library to include excerpts from other spaces.
We should integrate the macro with the include library feature in the same way as we did for the include+ macro so that the macro would respect version and language mappings when resolving the correct excerpt.

Environment

None

Activity

Show:
Marco Spinello
April 21, 2020, 11:01 AM

Hi David,

Thank you for your reply.

Our preference for the Excerpt include + macro over Include + is due to the fact that the former enables inline embedding. So we can reuse content at sentence level instead of paragraph or page level. This is extremely helpful, for example, when documenting similar procedures that have most steps in common, and only a few differences. Each step is an excerpt, and we assemble them in the target spaces pretty much as if they were LEGO blocks.

We do enforce one excerpt per page and have a standardized way to name excerpt pages in our reuse space.

If the Include + macro could be enhanced to offer the option to embed the content inline, it would allow us to:

  • Apply Scroll Versions to our reusable content space

  • Map reusable space versions to corresponding versions in our authoring spaces

  • Use Include + to insert excerpts from the mapped version of the reusable content space into our target authoring spaces.

This would be a big win for us. The main drawback in our current reuse strategy is that we cannot map versioned spaces (target ↔︎ reuse) AND have the option to embed content inline.
We have to choose if we want to version (through Include +), OR if we want to do inline embedding (through Excerpt include +).

Kindest regards,
marco

David Majninger (K15t)
April 20, 2020, 11:43 AM

Hi and

thanks for providing the input! Let me provide some insight into this issue from our point of view:

As outlined, a content reuse strategy across spaces can be achieved using only page includes. The addition of the Excerpt-Include+ to this setup allows for one less hierarchy level in the library space.

From a usability point of view, we found that working with full page includes is more usable, since every snippet has a name (page title), making it easier to find in the include macro editor.

For these reasons' impact on the cost/benefit, we have not prioritized this issue so far.

Cheers,

David

Marco Spinello
April 15, 2020, 9:32 AM
Edited

Hi Christian, it would be possible to have multiple excepts on a single page by introducing an excerpt ID field.

When you insert an excerpt in a target page, you would need to specify the excerpt page and the excerpt ID.

Nice one! I’d be in for that, too!

Moreover, I’d like excerpts to support placeholders, too (I’m getting greedy I know) .
I know I can achieve a similar result using Scroll Version variants, but quite often I need slight variations of the same sentence inside the same documentation variant. And that’s where I’d love to be able to use placeholders in excerpts.

Christian Sprenger
April 14, 2020, 9:47 AM
Edited

Actually, I’d like to have multiple Excerpts within one Page, to be used separately.

We use the Glossary Plugin and all terms are on the same page.
I’d like to reuse each term individually and was hoping the +-Plugins could be flexible like that.

Marco Spinello
April 14, 2020, 9:30 AM
Edited

We would also be really happy to use this feature. Our current setup includes a dedicated space where we store all our reusable content. Each content snippet is an excerpt. We store one excerpt per page in the reusable content space.

We would love to:

  • Apply Scroll Versions to our reusable content space

  • Map reusable space versions to corresponding versions in our authoring spaces

  • Insert excerpts from the mapped version of the reusable content space into our target authoring spaces.

Currently, this is how the Scroll Versions Include + macro behaves. We’d love the Excerpt include + macro to offer the same functionality.

Assignee

Unassigned

Reporter

Sync User [K15t]

Labels

None

Participants

None

QA Status

None

Deployment

None

Documentation Status

None

UI Concept

None

External Votes

None

Components