Sub Section Macro

Redirection Notice This page should redirect to http://www.adaptavist.com/display/Plugins/Sub+Section.

• Each {sub-section} has to be distinguished by an unique ID.
• Addresses CONF-5913

{sub-section:1}1st section of doco - test addition...
test{sub-section}

Parameters

Required

• An ID must be specified directly after the : (colon). The ID used to identify the sub-section on the page, all sub-sections with the same id will end up with the same content after editing, hence this ID should be unique for the page.
  • Note: If the page content is included elsewhere by {include}, {metadata-from} or {zone-template-instance} or the like, the sub-section should be unqiue for the entire confluence installation, perhaps using the pageid in the sub-section id.

Optional

• showComment - Show/Hide the comment textbox in the sub-section. Either true or false. Default to true.
• comment - Set the text of the version comment. Default : "sub-section:ID edited".
• showMinorChange - Show/Hide the minorEdit checkbox in the sub-section. Either true or false. Default to true.
• minorChange - Either true or false. A minor change won't send a notification to watchers. Default to false.
• metadata - The key of the metadata in which the wikimarkup will be stored. Default: no metadata set.

All the parameters (keys and values) are case insensitive. Metadata keys are still case sensitive.

Release History

Example of use:

{sub-section:ID}text that can be edited{sub-section}

Issue Tracking:

This plugin is still a proof of concept and currently unsupported. Neither the initial author or subsequent authors are actively developing or handling issues on a regular basis.

Please report new issues in the JIRA project (linked above). In order to vote for any issues below, create a new JIRA issue with the appropriate details.

• use POST instead of GET (to alleviate the current ~2kb character limit (and/or note this limit on the form)
  
• manipulate text to be put into the page as a string, not regx. Regx manipulation was causing crashing when $ was used.
  
• add revision comment to the form
  
• add minor edit checkbox to the form (default=no)
  
• create a 'metadata' parameterthat will automatically load the 'sub-section' content into the named metadata store on the page (in addition to putting it in the page source itself, for versioning). this avoids problems with having to try to nest metadata and subsection macros within each other. Currently {metadata:test}{sub-section:page1section1}test{sub-section}{metadata} doesn't work as expected, as the sub-section macro is IN the metadata, and the reverse puts the metadata IN the subsection.
  
• Perhaps give parameter/option that lets you lose the "edit" button completely and make it so users can just click or double-click the text section to edit it? (...as shown here: http://www.appelsiini.net/projects/jeditable/default.html). This would be useful in tables. Imagine this with table-plus tables! Exciting!
  
• if possible, add watch this page checkbox to the edit submission form (default=yes). User can choose to update their page watch status when they make a change, but default it turns it on. (see 'autowatch' plugin)
  
• use a (configurable) 'pencil' edit icon to edit the sub-section rather than the grey edit box (aka [checklist plugin])
  
• use a (configurable) plain text, right-justified [edit] button to edit the sub-section, rather than the grey buttons
  
• change the 'edit' button (optionally?) to be FLOATING at the TOP RIGHT of the section that is editable, to minimize interruption of reading.
  
• If possible, automatically size the 'edit box' to fit in the same area as the 'div' or 'span' that the rendered text is occupying to minimally interrupt the viewers experience. Set a minimum size of 2 lines by 30 columns, or something similar, which might be overridden by parameters. If difficult, at least set the number of rows to the number of rows of wiki source text.
  
• create a table version that makes every cell in each table in the body a 'sub-section' editable field
  
• create a heading version that makes every h1..h5 section in the body of the macro sub-section editable
  
• sub-section does not require CAPTCHA, even if CAPTCHA is enabled for pages and comments for the site.
  
• On IE6.0, but not firefox, including a sub-section macro on a page causes the entire 'preview' tab to not render while editing a page using the regular edit feature. No java error is returned, but the tab is entirely blank. Of course, there is differences in the way visibility et display of elements are set in the two platforms. This is also observed for other plugins, such as [pagetreesearch] and [pagetree] macros (others?), but was broken and fixed in other plugins (examples?).
  

sub-section macro fails when within a metadata-list macro and content contains blank lines META-45

Fixed somewhere between confluence 2.3.3 and 2.5.7 by updating the wiki renderer. It now allows macros, such as sub-section, in table syntax to contain blank lines without breaking the table.

In general, sub-section works well within a metadata-list and metadata-report, as long as each sub-section (on each page) uses a unique identifier. However, a problem arises if you have blank lines in wiki table syntax (which is used for metadata-lists). Behaviour for metadata table is different than that of the default wiki table renderer. The problem may need to be fixed for metadata or sub-section or the wiki table renderer or all three. I will cross post this bug report.

*** The following does not work properly (sub-section breaks):
{metadata-list}
|| Summary | {sub-section:myid}text

text{sub-section} |
{metadata-list}

*** The following fails for table rendering, but sub-section and meta-data still both work:
|| Summary | {metadata:Summary}{sub-section:myid}text

text{sub-section}{metadata} |

*** The following works for both meta-data and sub-section:
{metadata:Summary}{sub-section:myid}text

text{sub-section}{metadata}

Sub-section version 1.7 and later now have a metadata parameter which simplifies the usage of metadata and sub-section together