Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-19054

Confluence search results should include content added to page via the {include} and {excerpt-include} macros

    • 5
    • 14
    • We collect Confluence feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      NOTE: This suggestion is for Confluence Server. Using Confluence Cloud? See the corresponding suggestion.

      To improve Confluence's search, please provide an option to resolve all

      {include}

      and

      {excerpt-include}

      macro content before Confluence indexes whole page content.

      Problem

      When Confluence indexes page content for searches, it doesn't resolve the content of these inclusions into the page first. Hence, when the user attempts to search for a page based on a term that's actually part of an inclusion's content, then the page that 'hosts' the inclusion will not show up in the search results.

      As far as the user is concerned, those terms are on the page when they view it. It's not until the user looks at the page's Wiki Markup when they'll realise that the content is only being referenced via an inclusion macro (and why the search didn't retrieve the 'host' page).

      It's often more useful to see the names/titles of these 'host' pages in search results, rather than those of the actual 'inclusion pages' themselves, since 'inclusion pages' (and titles) are typically out of context.

      Solution

      To improve Confluence's search efficacy, Confluence could provide an admin console option to makes it resolve the content of all {include} and {excerpt-include} macros first, before it indexes the whole page content.

      If Confluence could resolve all inclusions before indexing whole page content, this will provide the following benefits:

      • If a user searches for text contained within {include} or {excerpt-include} macros, the names (and links) of pages that include this content will appear in the search results, rather than just the 'inclusion pages' further down the list of search results.

      • If a space uses the new 'Documentation Theme' and a user searches for text contained within {include} or {excerpt-include} macros using the search box in the TOC column (for example, any one of our product documentation spaces on CAC), the pages that include this content will appear in the search results, rather than not at all.

        Why would these searches show no results?

        The Documentation Theme requires a 'root page' within the space (from which the TOC is generated) to be set. When you start viewing pages within the space, the search box in the TOC column (by design) will only search pages contained within the 'root page' hierarchy. 'Inclusion pages', however, are typically kept outside this hierarchy to prevent them appearing in the TOC. Hence, if you use this Documentation Theme search box to look for terms contained within an 'inclusion page', you're likely to get no results.

            [CONFSERVER-19054] Confluence search results should include content added to page via the {include} and {excerpt-include} macros

            Angela L. added a comment -

            This is still a huge issue. Please fix it.

            Angela L. added a comment - This is still a huge issue. Please fix it.

            Bump - this is still an issue

            Michael Taylor added a comment - Bump - this is still an issue

            Whats the latest update on this ?

            Rupesh Chavan added a comment - Whats the latest update on this ?

            Roland Trepesch added a comment - - edited

            Hello dear Atlassian team, 
            even though this is an old request and it's 2020 now,
            I would like to revive this feature request, as we have still problems with the implemented search limitations and they are really annoying. 
            As many people seem to have similar problems with it, I wanted to ask, if there is a known way, how macro content can be included into the search somehow,

            and  if not, if there is any perspective to get this feature in the near future. 

            Thanks for your help. 
            BR Roland Trepesch

            Roland Trepesch added a comment - - edited Hello dear Atlassian team,  even though this is an old request and it's 2020 now, I would like to revive this feature request, as we have still problems with the implemented search limitations and they are really annoying.  As many people seem to have similar problems with it, I wanted to ask, if there is a known way, how macro content can be included into the search somehow, and  if not, if there is any perspective to get this feature in the near future.  Thanks for your help.  BR Roland Trepesch

            Yeah, why is this still in the ominous status "Gathering interest"? With 130 votes and over 80 watchers, I'm pretty sure we have proved that there IS interest in getting this feature.

            Birgit Matuolis added a comment - Yeah, why is this still in the ominous status "Gathering interest"? With 130 votes and over 80 watchers, I'm pretty sure we have proved that there IS interest in getting this feature.

            johnnyjob added a comment -

            The issue was created in 2010 and now is 2019 and nothing has been done. Bravo Atlassian!

            johnnyjob added a comment - The issue was created in 2010 and now is 2019 and nothing has been done. Bravo Atlassian!

            Hi,

            The reason for an include function is that I can include once written text in different places. I do not want this included text to be found at the place where I save it, but at the place where I include and read it in the correct context.
            In our software documentation I even actively prevent the search from finding the primary pages with the text modules.
            Working with text modules is the basis of technical documentation. This approach is also constantly promoted by Atlassian gurus and plugin providers.
            For these reasons it is also surprising why this functionality is not standard.

            Thanks,

            Volker

            Volker Weinreich added a comment - Hi, The reason for an include function is that I can include once written text in different places. I do not want this included text to be found at the place where I save it, but at the place where I include and read it in the correct context. In our software documentation I even actively prevent the search from finding the primary pages with the text modules. Working with text modules is the basis of technical documentation. This approach is also constantly promoted by Atlassian gurus and plugin providers. For these reasons it is also surprising why this functionality is not standard. Thanks, Volker

            Not sure where the results of the survey posted here previously went, but I'd be happy to provide more use-cases or feedback about why this functionality is needed! 

            Josh Kanehen added a comment - Not sure where the results of the survey posted here previously went, but I'd be happy to provide more use-cases or feedback about why this functionality is needed! 

            +1 we desperately need to be able to search within macros. FAQs pages will not return results.  Agree with Jennifer above: how about a search macro where we can specify that we want data in the Excerpt macro ignored, and data in the Excerpt Include macro included in the search results.

            Julie Bateman added a comment - +1 we desperately need to be able to search within macros. FAQs pages will not return results.  Agree with Jennifer above: how about a search macro where we can specify that we want data in the Excerpt macro ignored, and data in the Excerpt Include macro included in the search results.

            Lack of such feature spoils the usability of one of the greatest Confluence's hallmark: excerpts.!

            Artur Franczuk added a comment - Lack of such feature spoils the usability of one of the greatest Confluence's hallmark: excerpts.!

              Unassigned Unassigned
              ggaskell Giles Gaskell [Atlassian]
              Votes:
              207 Vote for this issue
              Watchers:
              114 Start watching this issue

                Created:
                Updated: