Scaffolding 2 Beta

Added by David Peterson, last edited by David Peterson on Jan 19, 2007  (view change)

This page contains information about the Scaffolding 2 Beta.

Introduction | Installation | Plugin Repository (recommended) | Manual Installation | What's New | In DR3 | In previous versions | Usage | Creating Scaffolded Pages | Editing Scaffolded Pages | Editing the original page wiki | Fun Stuff To Do | Bugs and Feature Requests | Known Issues

Introduction

Scaffolding 2 is an upgrade of the Scaffolding Plugin which has several goals:

Goal Status Version Comment
Better integration with Confluence 2.2-dr1 Scaffold data is edited by clicking the standard 'Edit' tab.
Less annoying UI 2.2-dr1 There are less trips back to the server, and tables and repeating sections can be modified dynamically.
Version history 2.2-dr2 All changes to scaffold data is now recorded and stored for posterity. It can be retrieved by restoring versions in the usual Confluence way (Info > History > Restore)
Display individual Scaffolding data in other pages. 2.2-dr3 Stored scaffolding data can be retrieved with the {get-data} macro, both from the current page and from other specific pages.
Display scaffolding data in reports 2.2-dr3 While the report generation is actually achieved via the Reporting Plugin, this version provides a data supplier component for that plugin. Prefix any requests with "data:" to retrieve scaffolding data.
Make Metadata Plugin compatible with Scaffolding data.   This is more of a goal at the Metadata end now. The intent is to make them compatible, but it has proven to be a larger task than originally hoped.

There are other goals, most of which can be seen in the 'Known Issues' list below.

Installation

This does not yet work in Confluence 2.3. Stay tuned for a 2.3-friendly release.
This is a replacement for Scaffolding 1.x. It uses a different data back-end, but will import old data where it is available. However any new data saved will not be accessible if you decide to go back version 1.

DO NOT USE IN A PRODUCTION ENVIRONMENT

Note
Currently manipulating tables and repeating data only work when using FireFox. IE and Safari support will be a priority for the next release.
If you just want to try out the new features, feel free to play around with the Scaffolding Test page, or create your own in the Sandbox.

Plugin Repository (recommended)

  1. Navigate to the Plugin Repository console for your server.
  2. Ensure that 'All versions' are being displayed (set in the 'Configure' tab).
  3. Install/Update to 2.2-dr3

Manual Installation

  1. Uninstall any existing copies of the Scaffolding Plugin.
  2. Upload scaffolding-plugin-2.2-dr3.jar from the Admin console.

What's New

In DR3

  • Get and set scaffolding data directly via {get-data} and {set-data}
  • Create reports on pages containing Scaffolding data via the Reporting Plugin.
  • Lots of bug fixes.

In previous versions

  • Version history for field data - you can now go back in history for all modifications to field data.
  • Indexing - Most data is now indexed and will show up with a regular search.
  • Better data editing integration - To edit, just click the regular 'Edit' tab and you can access your data fields.
  • Dynamic table and repeating sections - You can add, remove and reorder table sections without reloading the page.
  • Preview your page - Check out your changes before you save them.

Usage

There are video tutorials available, demonstrating several key features of using Scaffolds.

Creating Scaffolded Pages

  1. Click 'Add Page'
  2. Enter the details, and use any of the scaffolding data macros (eg. {text-data:Text})
    Note
    You do not need to use the {scaffolding} macro any more. It is still available for backwards-compatibility, but is completely optional. If you wish to group data on new pages, use the new {group-data} macro instead.
  3. Click 'Save'. You will be redirected to the new 'Edit Page Data' page, which displays a preview of the page, with edit fields where data macros are.
  4. Click 'Preview' to preview your changes before you save.
  5. Once you have filled in the data macros, click 'Save' again to finalise your changes.

Editing Scaffolded Pages

  1. Navigate to a scaffolded page
  2. Click 'Edit'
  3. You will be taken to the 'Edit Page Data' screen, as you were after creating the page initially. Rinse and repeat.

Editing the original page wiki

  1. Navigate to a scaffolded page
  2. Click 'Edit'.
  3. You will be taken to the 'Edit Page Data' screen. Now click 'Edit Original'.
  4. Make your changes and click 'Save'. You will be returned to the 'Edit Page Data' screen.
  5. Finalise your changes and click 'Save'.

Fun Stuff To Do

  1. Create a page with {repeating-data} or {table-data}. Have fun dragging-n-dropping the rows around. (Note: IE has a bug where deleting table rows will not work)
  2. Put your scaffold data in {deck} macros and enjoy flipping between tabs.
  3. Put a {table-data} macro inside a {chart:dataDisplay=true} and edit the data inline. (no live update yet though)

Bugs and Feature Requests

Log any bugs or Feature Requests [here]. Please log them against the appropriate version to make it easier to track which version you are having trouble with.

Known Issues

Adaptavist Public Issue Tracker (18 issues)
Key Pr Summary Updated Reporter Status
SCAFF-39 Critical Make scaffolding more friendly with 2.x Rich Text Editor Jun 23, 2006 David Peterson Open
SCAFF-71 Critical Detect if any scaffolding data has changed when editing. Jun 19, 2008 David Peterson Open
SCAFF-55 Major Extensions to "hidden data" Sep 29, 2006 Guy Fraser Open
SCAFF-60 Major Interoperability with the metadata plugin Dec 11, 2007 David Peterson Open
SCAFF-61 Major Allow cards to be added to decks dynamically Jul 14, 2006 David Peterson Open
SCAFF-68 Major Save draft of scaffold-edited page Sep 23, 2006 David Peterson Open
SCAFF-72 Major Enable scaffolds to be edited in blog posts. May 31, 2007 David Peterson Open
SCAFF-78 Major Provide XML-RPC access to scaffold data Nov 20, 2006 Damon Rand Open
SCAFF-91 Major Create an 'alternate-data' macro Sep 19, 2007 David Peterson Open
SCAFF-123 Major Using the {attachments} macro with scaffolding breaks the input buttons at the bottom of the page in Internet Explorer May 31, 2007 Britt Treece Open
SCAFF-127 Major Automatic sorting of {repeating-data} sections May 31, 2007 Jeff Heinen Open
SCAFF-131 Major Allow Rich-Text Editing in Textarea Fields Apr 15, 2008 brian thomas Open
SCAFF-157 Major image-data macro needed Oct 10, 2007 Stefan Baader Open
SCAFF-185 Major "Insert image" and "Insert link" disappear using {text-data} Aug 29, 2008 Hendrik Vermeiren Open
SCAFF-45 Minor Table with auto-generated ID column Jul 07, 2007 James Open
SCAFF-111 Minor Extend the list-data to display the un-selected options. May 31, 2007 Jeff Heinen Open
SCAFF-116 Minor formatting of repeating data. May 31, 2007 Jeff Heinen Open
SCAFF-130 Minor Auto-increase for number-data in a table-data object Jun 29, 2007 Jeff Heinen Open

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (5)

 

  1. Feb 19, 2007

    Anonymous says:

    With scaffolding 2.2 dir3 under Confluence 2.2.10 it seems the "groups=" option ...

    With scaffolding 2.2 dir3 under Confluence 2.2.10 it seems the "groups=" option for the user-optionsmacro doesn't work.  And - it's probably possible to create a more cumbersome way to report bugs, but it would be a challenge.  But thanks for a great macro, it's just hard to help improve it by reporting bugs.

    1. Feb 20, 2007

      David Peterson says:

      Yeah, sorry about that. In fact, it has been a problem since at least 1.4.18. th...

      Yeah, sorry about that. In fact, it has been a problem since at least 1.4.18. this has been corrected for the next version (due out soon).

  2. Feb 23, 2007

    Anonymous says:

    Is there some kind of roadmap available? When will be the estimated release date...

    Is there some kind of roadmap available? When will be the estimated release date of scaffold2 working with conf 2.3.x?

    Something like: Next month or maybe next year?

  3. Aug 26, 2007

    Anonymous says:

    Can you access scaffolding data in beanshell scripts? thanks

    Can you access scaffolding data in beanshell scripts? thanks

    1. Aug 27, 2007

      David Peterson says:

      Not that I'm aware of. I'm not sure what would have to be done to hook them toge...

      Not that I'm aware of. I'm not sure what would have to be done to hook them together.

Add Comment