silentspot.blogg.se - Copy space plugin for confluence

#Copy space plugin for confluence how to#
#Copy space plugin for confluence update#
#Copy space plugin for confluence free#

Go to your new inclusions page and choose Create to add child pages containing your re-usable contentīecause you've moved the pages to the root of the space, they won't appear in the page tree in the sidebar. The pages will be picked up by other searches though, as they're normal Confluence pages.Choose Space tools > Reorder pages and drag your new page above the space homepage.

#Copy space plugin for confluence how to#

Enter some content and save the page We enter text explaining the purpose of the inclusions library and how to re-use the content.We use '_ConfluenceInclusions' (the underscore before the title helps to let people know this page is special)

Choose Create and create a new page in your space.

You can include content from any Confluence page, but you may want to create an 'inclusions library' to hold content that's specifically for re-use. The inclusions library isn't a specific feature of Confluence the pages in the inclusions library are just like any other Confluence page. This is just a technique you can use if you want a place to store content that's specifically for re-use. By going to > Page Information, we can see how many incoming links there are to this page, and that tells us how many pages use the image. Doing it this way also allows us to know how many pages we're using the image on.

#Copy space plugin for confluence update#

Why do we do use an Include Page macro for one tiny image? Well, just in case that UI element is ever changed. If we attach the image to every page, there might be 50 pages we need to update when things change if we use an Include Page macro, we update once and it's changed everywhere. We have a page with just that image on it, so we can include it whenever we need an ellipsis. Whenever the ellipsis ( ) appears in our documentation – for example, go to > Copy – it's actually an Include Page macro.

Excerpt include: these are excerpt include macros.Īnother example is one of the ways we use the Include Page macro.

Excerpts: the intros to these pages are in excerpt macros.

Place each release notes intro in an Excerpt macro, then add an Excerpt Include macro for each set of release notes to the what's new page. Your intros will magically appear on the what's new page, and if you update the release notes it'll automatically update the what's new.

The Include Page macro ( include) to include the entire content of a page on another page.įor example, let's say you create release notes for each major release of your product, and you want to include the intro from each release notes page on a 'what's new' page.

The Excerpt Include macro ( excerpt-include) to include the contents of an excerpt on another page.

The Excerpt macro to define a re-usable section, or 'excerpt', on a page – add content inside this macro, and you can reuse it on as many pages as you like.

There are 3 macros that allow you to re-use content: Inclusions not only save you typing the same thing many times, they also make it easier when things change – it's much better to update the info in one place, than 47! If there's something you're going to use multiple times in your documentation space – whether it's a word, sentence or paragraph an image a product version number or anything else – you can create it once and include it on as many pages as you like (or use it in the header and/or footer).

#Copy space plugin for confluence free#

Feel free to customize the home page at any time what it looks like is completely up to you! Give your space a name, and Confluence will automatically create the home page and space key for it (change the space key if you're not happy with the one Confluence chooses for you). To make things even easier, choose the 'Documentation Space' option in the create space dialog it'll give you a custom home page with a search box (the livesearch macro) to search just your documentation space, a recently updated macro, and a few other goodies. All you need to do to get your documentation started is choose Spaces > Create space from the Confluence header. Create your Documentation SpaceĬreating spaces in Confluence is quick and easy. Below are some tips to help you get your technical documentation site started, and to save you time and effort managing your documentation's life cycle.įor another great overview of how you can use Confluence for documentation check out Rock the Docs from our solution partner, K15t. Confluence is a flexible platform with a range of features and Marketplace apps that can help you capture, distribute, and update your technical documentation.