| Name | Page Flag Plugin |
|---|---|
| Version | 1.0 |
| Product Versions | Confluence |
| Author(s) | [~James Matheson] |
| Homepage | You're looking at it |
| Price | Free |
| License | BSD |
| JavaDocs | |
| IssueTracking | |
| Download JAR | pageflagplugin-1.0.jar |
| Download Source | pageflag.zip |
Description/Features
The page flag macro creates a check box on a page. The check box is linked to a label and metadata such that when the checkbox is changed,the label and metadata are also changed.
This macro is useful as a simple and fast input mechanism for setting predefined labels and metadata.
Usage
{pageflag}
This macro places a check box on the rendered page. The check box value is written to the 'key' as a label and as metadata. This macro does not have a body.
| Parameter | Description | Type | Default | Required |
|---|---|---|---|---|
| key | The name of the key that will be set (or cleared) when the check box is clicked. |
string | none |  |
| page | The name of the page that will store the key | string | Current page |  |
{pageflag-block}
The page flag block is used to create a type of form where all the {pageflag} macros within the body of this macro are submitted at the same time, i.e. when the user clicks on the 'Submit' button.
| Parameter | Description | Type | Default | Required |
|---|---|---|---|---|
| none |
Examples
Simple example
{pageflag:key=foobar}foobar
Creates a single check box on the page. The label and metadata values on the current change when the user clicks on the box. The label created when the user first clicks on the check box will be 'foobar=y' and when the check box is cleared, but label will changed to 'foobar=n'. The metadata is modified in the same way.
Block example
{pageflag-block}
{pageflag:key=value1}Value 1{pageflag:key=value2}Value 2
{pageflag-block}
Creates a block with two check boxes and a submit button. The label and metadata values change when the user clicks on the 'submit' button.
Remote page example
{pageflag:key=foobar|page=Home}foobar
Creates a single check box on the page. The label and metadata values on the Home page change when the user clicks on the box.
Version History
Screenshots
Screenshots |
|
|---|---|
|
|
|
Comments (11)
May 11, 2007
Guy Fraser says:
Could you change it so that the pageflag macro has a body which contains the lab...Could you change it so that the pageflag macro has a body which contains the label then output the label using a HTML <label> tag with a for="id_of_checkbox" as this will make the form more accessible
Jun 28, 2007
Ville Valtasaari says:
Nice one, I would, however, like to be able to choose whether this macro does an...Nice one,
I would, however, like to be able to choose whether this macro does anything with labels or not. In most cases I'd prefer it not to write a page label at all, just the metadata.
Jun 28, 2007
Guy Fraser says:
It would be useful if you could define the label / metadata separately eg. I mig...It would be useful if you could define the label / metadata separately - eg. I might only want metadata, I might only want label, I might want a label and metadata but different keys.
Aug 13, 2007
s wargnies says:
Hi, It seems that I have a problem. If I download the JAR and try to upload it h...Hi, It seems that I have a problem.
If I download the JAR and try to upload it here is what I get:
Page Flag Plugin
Vendor: Saikore
Plugin Version: 1.0
Page flag macros
Uninstall plugin pageflag
Set or clear a metadata value on the given page.
Error:There was a problem loading the descriptor for module 'macro' in plugin 'Page Flag Plugin'. Class version is incompatible with current JVM: com.atlassian.confluence.extra.pageflag.PageFlagMacro
Worse is if I try to dowmnload the zip with the source code. It appear to be a corrupted archive for my winzip.
Any ideas ?
Cheers
PS my confluence is 2.5.6, JVM version is 1.4.2_13-b06 and Java version is 1.4.2_13
Nov 27, 2007
James Matheson says:
Unfortunately the plugin was compiled with Java 1.5, so you will need to use Jav...Unfortunately the plugin was compiled with Java 1.5, so you will need to use Java 1.5 with your Confluence installation to make the plugin work.
Sep 10, 2007
Jing Liu says:
This is a very useful plugin. But when I installed the plugin, the same err...This is a very useful plugin. But when I installed the plugin, the same error as above occurred. Is there any new updated version of this plugin available?
Thanks a lot.
- Jing
Nov 27, 2007
James Matheson says:
As per my comment above, you need to be running on Java 1.5As per my comment above, you need to be running on Java 1.5
Nov 26, 2007
Paul Csapo says:
This is pretty nifty, and works with v2.4.3 Also allows for lable searches ...This is pretty nifty, and works with v2.4.3
Also allows for lable searches too.
Now to test with 2.5.7
regards,
Paul
Apr 15
Davide De Benedictis says:
Hi James, Would be very nice having the chance to choose if using labels or meta...Hi James,
Would be very nice having the chance to choose if using labels or metadata instead of both.
This is my need (was my comment on the metadata plugin)
One user should create a new page from a "test case template". This page should have two metadata:
test_written=false
test _done=false
These metadata are presented to the user as checkboxes, so, from the UI point of view I imagine them as:
When a user has completed the test writing or completed the test case just checks one or both the checks.
Later, in a parent page, I could create powerful reports on project test case progress just querying metadata values...
Let me knows when your plugin will be released.
Davide
Apr 15
James Matheson says:
Hi Davide, Thanks for the feedback, it is a good idea. The plugin has been relea...Hi Davide,
Thanks for the feedback, it is a good idea. The plugin has been released, but I don't have any plans to modify it at the moment. Note that you might be able make use of theChecklists Plugin Checklists Plugintoo.
James.
Jun 24
Ricardo Sueiras says:
Attached a version of this plugin compiled for JVM 1.4.2. I have it working with...Attached a version of this plugin compiled for JVM 1.4.2. I have it working with Confluence 2.6.2. Hopefully it will be of use as this is a most useful plugin...