Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
doctypeapp-tool
overridefalse


Short DescriptionWithin the page editor the section expander tool allows you to collapse and expand areas of page content.
NameSection Expanderhide
Short Namehide
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
valuereleased

hide
Type
Name List
doctypeapp-tool-type
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyType

Suite
Name List
doctypeapp, app-extension, product-space
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
defaults-toancestor
propertySuite
hide
App Tool
Name List
doctypeapp-tool
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
defaults-toancestor
propertyApp Tool

Since5.0
Deprecated
Removed
Sort Keyhide
Client Logging Moduleprojectdoc-editor-section-control



Section
show-titlefalse
titleDescription

The page editor may be cluttered with macros and information that are in this instance of time not of use. To remove this clutter from your view the Section Expander tool allows you to collapse and expand selected macros.

While one of the key features of the projectdoc Toolbox is clutter-free reading (see

Static Document Link
documentGuided Writing & clutter-free Reading
) this feature brings clutter-free writing at a new level.

...

Section
titleDetails

Some details on how to use this tool.

Section
titleExperimental Status

This feature has been release with version 5.0 of the projectdoc Toolbox as experimental.

The basic functionality is there, but some fine tuning is still required. For instance accessibility is missing. You need to use the mouse to get the macros collapsed and expanded. The controls are not yet very intuitive, meaning: if you do not know the feature, you will probably not learn it without reading this documentation.

Feedback is welcome!


Section
titleWhat does it do?

Consider this page at an early stage.

And this is the same page where every section without content is collapsed (using Ctrl+Shift-Click on a macro chrome - for instance the title of a

Static Document Link
documentSection Macro
).

You can easily toggle each macro, toggle all macros or toggle all macros with an empty body.


Section
titleHow does it work?

You need to click on the chrome, for instance on the macro head.

ActionResult
Shift-ClickToggle the state (collapsed / expanded) of the selected macro.
Ctrl-ClickToggle the state (collapsed / expanded) of all macros dependent on the state of the macro you actually clicked. If the macro is collapsed, all macros will be expanded. If it is expanded, then all macors will be collapsed.
Shift+Ctrl-ClickToggle the state of all macros whose body is considered to be empty. The body is considered empty, if it contains no text. For instance a macro with placeholder text (the text that tells you what a section is intended for) or with another macro in its body is considered empty.
Click on collapsed macroExpands the macro (as would Shift-Click, but easier).



Section
titleHow is it integrated?

Users in the group of confluence-administrators are able to activate (default) and deactivate the feature on the Features control panel.

In case you find this feature confusing or it interferes with other tools you use on your Confluence platform, simply deactivate it.

The feature may also only be activated for the listed Confluence groups. If no group is specified there is no restriction.

Administrators may also specify the names of macros that use the feature to collapse and expand.

You may use a wildcard at the end of the macro name which will match all macro names with the given prefix.

Example Box
titlePrefix Match

The macro name projectdoc-box-* matches projectdoc-box-caution, projectdoc-box-warning, and any other macros whose name starts with projectdoc-box-.

So all box macros provides by the projectdoc Toolbox will use this feature.

Note that you are not restricted to macros provided by the projectdoc Toolbox. section, expand, and panel are macros provided by Confluence.


...