Date: Thu, 28 Mar 2024 13:50:33 +0100 (CET) Message-ID: <652963165.17415.1711630233305@09e9d69a2016> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_17414_2135636429.1711630233305" ------=_Part_17414_2135636429.1711630233305 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Doctype as a Parameter, improved = Support for Attachments, plus more new features, improvements, and bugfixes= .
Today we released version 4.2 of the projectdoc Toolbox on the Atlassian Marketplace!
This release provides new features, improvements, and bugfixes.
The projectdoc Toolbox is an add-on for Conflue= nce supporting agile software development teams to collaborate on proce= ss, project, system, and product documentation.
If you want to learn more about the projectdoc Toolbox and how it helps = to create good project documentation, please refer to the introduction vide= o!
The following image is a link to a=
video on YouTube. When you click the link your browser will serve a page f=
rom youtube.com
.
Very interesting, but way too fast?
S=
tep through at your own pace with with our Prezi Presentation (external link to prezi.com
)!
In the Online M= anual you=E2=80=99ll find additional video material that introduces you= in the concepts of the projectdoc Toolbox.
Refer to use cases an= d show cases for inform= ation on how to use the projectdoc To= olbox.
A projectdoc Document demands a Name and a Doctype to be set. All other document properties are recommended, especially th= e Short Description= , but are not necessary.
Since Nameless Documents the name of a projectdoc Document= may be derived from the Title<= /a>. Since the title is mandatory for a Confluence page, the only property = still required being part of the table within the Document Properties Mark= er Macro was the Doctype.
The Doctype property's value also needed to= be provided in plain text. The projectdoc Toolbox does not a macro here si= nce the value is required before any property value resolvement takes place= .
This version of the projectdoc Toolbox allo= ws to specify the doctype as a parameter to the Document Properties Marker = Macro. This way the property cannot be accidentally be removed or changed. = Since the property is hardly ever changed, it will not take space in the ed= itor, too.
Note that a property with name Doctype stil= l overrides any value set with the macro parameter. This is to ensure backw= ard compatibility. It is not meant to be a standard use case.
Here is an example showing the doctype 'tod= o' as part of the macro.
When opening the macro in the editor, the D= octype parameter shows the type if the document.
The projectdoc Toolbox provides support to render the contents of an att= ached file. This allows template authors to design document types (blueprin= ts) that show contents from files easily. From the moment a user attaches a= document, the contents will automatically been shown.
Name | Short = Description | Add-on |
---|---|---|
projectdoc Toolbox
|
||
Renders a code block from an attached file with placeholders replaced by pr=
operties.
|
||
Renders code of attached file, referenced by local property, with placehold=
ers replaced by properties.
|
The Attachment Link Macro makes it easy to r= eference an attachment as a property value. Use the Refer= ence Attachment Code Block Placeholder Macro to render the attache= d file (or a part of the file) in a code box. In case there is no need to h= ave the attached file as a property, use the Attachment Code Block = Placeholder Macro.
The Autocomplete with this version also supp= orts selecting attached files.
When a transclusion macro renders content, the layout may be affected. T= his is typically because the transcluded content is rendered inside a HTML = div element. This way CSS selectors on first element may not be applied or = (not applied) as expected.
The users now can add additional CSS rules by referencing the selector "= projectdoc-transcluded-content" which= is rendered with the transcluded content.
The Section Mac= ro and the Content Marker Macro allow to control the rendering dependent on th= e evaluation of document and space properties. Prior to this version all li= sted properties have to meet the constraints (i.e. they were ANDed). With t= his version authors can specify that at least one property must match (i.e.= they are now ANDed or ORed).
Currently we do not support more sophisticated queries using AND and OR = in one specification.
This version has no breaking changes.
Install the new OBR of the projectdoc Toolbox, then the extensions liste= d below. After that the doctype add-ons starting with Core.
The following changes are part of the latest projectdoc Toolbox<= /a> for Confluence.&nbs= p;
Key | Summary | T | P | Status | Resolution | Description | |
---|---|---|---|---|---|---|---|
PDAC-116= 0 | Render Link to attached = File | <= /a> | Done | Fixed | Provide a macro that = renders a download link to an attached file on the same document. |
||
PDAC-116= 4 | Default Strategy for No = Names | <= /a> | Done | Fixed | Provide a parameter t= o specify what to do to derive a default value for the Name List Macro in c= ase there is no name specified. The default is "none", but there is a= lso "ancestor" (for searching an ancestor document like the Ancestor Macro)= , and "all" (like uncheck empty handling). |
||
PDAC-116= 3 | Support Autocomplete for= Attachments | <= /a> | Done | Fixed | Provide an infrastruc= ture to autocomplete names of attachments. There is a service provide= d by Confluence, but we need to allow to have an optional value and set a n= ame that does not yet exist. |
||
PDAC-116= 5 | I18N Bundle Support for = JavaScript | <= /a> | Done | Fixed | Provide a REST servic= e that allows JavaScript clients to create a translation bundle for a list = of I18N keys. |
||
PDAC-116= 6 | Add Selectors for Transc= luded Content | <= /a> | Done | Fixed | Transcluded content m= ay not fit nicely into the target location by adding or removing margin or = padding. Thus the content is not easily to read. We need to add selec= tors to allow users to adjust any inconvenient margins/paddings by selectin= g only on transcluded content. Therefore each transclusion macro shou= ld add a class to the container rendering the transcluded content. This cla= ss is "projectdoc-transcluded-content". This additional class would b= e provided by transclusion macros such as the Transclusion Macro and the Tr= ansclude Documents Macro. |
||
PDAC-117= 6 | Provide Translation Serv= ice | <= /a> | Done | Fixed | Required to use this = service outside the internal REST API. |
||
PDAC-117= 0 | Support Wizard Parameter= s in Doctype Model | <= /a> | Done | Fixed | Provide the wizard pa= rameters set to the soy templates also at runtime to the Doctype Instance v= ia the Doctype Service. This information is required by e.g. REST ser= vices that create documents based on blueprints. This way the parameters ca= n be applied in both contexts per default. |
||
PDAC-115= 6 | Provide Default Doctype = with Document Properties Marker Macro | <= /a> | Done | Fixed | Allow to set the doct= ype with the Document Properties Marker Macro by a parameter. The par= ameter will remove one line from the properties table so that no properties= may be empty. Since the Doctype property's constraint requires the value t= o be plain text, specifying it as a parameter is less error prone. Th= e Doctype property may still override the one specified with the parameter.= |
||
PDAC-117= 4 | Render URL Property with= an alternative Label | <= /a> | Done | Fixed | Provide a macro to re= nder a link with a new label. The link is provided by a property and the ne= w label is specified with the macro. This allows to render a link to = a resource referenced by a property with a label that is suitable for the c= ontext of the link. |
||
PDAC-117= 2 | Allow OR on Required Doc= ument Properties | <= /a> | Done | Fixed | We currently do not s= upport complex checks on required document properties for the Content Marke= r Macro and the Section Macro. Only all matching propery use cases are supp= orted. Since the use case where any one of a list of properties is qu= ite common, we should support this use case, too. To make this feature avai= lable without adding any new properties, we simply allow to switch semantic= s by setting a pipe character (|) as the first character of the parameter v= alue:
|
||
PDAC-115= 7 | Add Tooltip Override | <= /a> | Done | Fixed | Provide a parameter t= o the Wiki Link Macro to allow to override the tooltip. |
||
PDAC-116= 2 | Update for every Attachm= ent Event | <= /a> | Done | Fixed | In case an attachment= is updated, the document should be recalculated since properties might ref= erence the new macro. Currently we check if the property is marked, b= ut this now seems not feasible any longer with the new Attachment Link Macr= o. Therefore we skip the is-relevant test. In case we encounter performance= issues we would need to check this code again. |
||
PDAC-117= 3 | Allow OR on Required Spa= ce Properties | <= /a> | Done | Fixed | We currently do not s= upport complex checks on required space properties for the Content Marker M= acro and the Section Macro. Only all matching propery use cases are support= ed. Since the use case where any one of a list of properties is quite= common, we should support this use case, too. To make this feature availab= le without adding any new properties, we simply allow to switch semantics b= y setting a pipe character (|) as the first character of the parameter valu= e:
|
||
PDAC-117= 1 | Merging with Placeholder= | Done | Fixed | When creating a proje= ctdoc document merges initial values, a placeholder value must be considere= d an empty value. |
|||
PDAC-116= 8 | Allow to Workaround the = first-child Issue | <= /a> | Done | Fixed | When the Content Mark= er Macro renders an identifier (or by any other means the macro requires to= render an additional div element), the contents of the macro will probably= be rendered as the first child of this container. This may cause the= application of CSS rules that now apply first-child styles, even if this m= acro is rendered logically not as a first child. We add a feature to = the macro so that the writer may configure the behavior. The value of a par= ameter, document property, or space property will control whether or not an= additional span element is rendered thus making the content of this macro = not its first child. This feature is considered experimental. |
||
PDAC-117= 8 | Don't log Illegal Argume= nts | <= /a> | Done | Fixed | In case a macro rende= ring a code snippet signals illegal arguments, that exception must not be w= ritten to the log. |
||
PDAC-117= 7 | Render Error box properl= y | <= /a> | Done | Fixed | |||
PDAC-116= 7 | CSS Class for "No Permis= sion Required" | Done | Fixed | In case no permission= is required to render content the macro renders a class name that is misle= ading. The rendered class name is "permission-required" while it shou= ld render "no-permission-required". |
|||
PDAC-116= 9 | Split null value to empt= y list | Done | Fixed | ||||
PDAC-115= 8 | Update Description for R= equired Properties | Done | Fixed | The Section and Conte= nt Marker Macros allow to match a property value to be a required value, bu= t the short description of the parameters (space and document) does not ref= lect this. |
|||
PDAC-115= 5 | Fix Text Resources <= /td> | Done | Fixed | Fix double keys. <= /td> | |||
PDAC-117= 5 | Missing Autocomplete for= Link Property | Done | Fixed | The autocomplete feat= ure is not available for the Link Property of the Display Document Property= as Image Macro. |
The following extensions are required to be= updated for the projectdoc Toolbox.
All extensions are optional. In case an ext= ension is not installed, there is no need to install it for this version of= the projectdoc Toolbox.
The following changes are part of the latest Web API Extension.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDEXWA= PI-45 | I18N Translation REST = Service | Done | Fixed | The service is copyin= g the internal I18N service by making it part of the public Web API. | ||
PDEXWA= PI-40 | Apply Wizard Parameter= s | Done | Fixed | REST services need to= create documents based on blueprints the same way the standard wizard usin= g soy templates does. Since the information is now provided by the Do= ctype Maven Plugin, and made accessible by the projectdoc Toolbox 4.2, this= information is now applied in the document creation process when called vi= a REST. |
||
PDEXWA= PI-42 | Validate Document Argu= ments | Done | Fixed | Validate Input Docume= nts. Properties must provide a name. |
||
PDEXWA= PI-43 | Support Replace Values= for Patching a Property | Done | Fixed | Currently replacing v= alue is not supported. |
||
PDEXWA= PI-44 | Reassign the Space Key= to the Parent Document | Done | Fixed | Confluence cannot cre= ate a page to a parent that is not in the same space. |
||
PDEXWA= PI-41 | Obey Content Type on E= rror | Done | Fixed | When an error is retu= rned, the Web API always returns the result object in XML despite the selec= ted content type. |
The following changes are part of the latest Bookmarklets Extension.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDEXBML= -14 | Bookmarklet Button Macr= o | = | Done | Fixed | Add a macro to provid= e a function to render a bookmarklet. This way it will be easy for readers = on a bookmarklet page to add the bookmarklet to their bookmarks per drag-an= d-drop. |
|
PDEXBML= -12 | Create Resource Bookmar= klet | = | Done | Fixed | Add services to imple= ment a bookmarklet to create a projectdoc document based on information fro= m a remote web page. |
|
PDEXBML= -13 | Remove Comments | = | Done | Fixed | Remove comments that = start with the first character on a line. |
|
PDEXBML= -11 | Bookmarklets JavaScript= API | = | Done | Fixed | Provide an API for bo= okmarklets operating on the Confluence site. This should make it easier to = develop bookmarklets. |
The following changes are part of the latest Information Systems Extension= .
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDEX= INFOSY-33 | Render Code from att= ached File | Done | Fixed | Allow to reference an= attached file to show the code in a Code Macro. |
||
PDEX= INFOSY-32 | Render Code from att= ached File referenced by a Property | Done | Fixed | Allow to reference an= attached file via a property reference to show the code in a Code Macro.= p> |
||
PDEX= INFOSY-29 | Allow Property to re= ference a remote File | Done | Fixed | The Text Snippet Macr= o and HTML Snippet Macro allow to transclude content via an URL. These macr= os should provide an additional parameter allowing to specify a property th= at holds the URL as value. |
||
PDEX= INFOSY-31 | Provide Space Proper= ty to Control Default Lines Parameter | Done | Fixed | For the transclusion = macros allow to specify the value for the lines parameter by a space proper= ty named 'projectdoc.extension.information-systems.transclusion.lines'. = |
||
PDEX= INFOSY-30 | Default for Autoconv= ert Check Parameter | Done | Fixed | Provide a space prope= rty that controls whether or not the check parameter of a System Link Macro= should be set per default or not. |
||
PDEX= INFOSY-35 | Allow Start Snippet-= ID only | Done | Fixed | Allow to find only th= e Snippet Start ID and then run to the end of the file. |
||
PDEX= INFOSY-34 | Render Error box pro= perly | Done | Fixed | |||
PDEX= INFOSY-36 | Don't log Illegal Ar= guments | <= /td> | Done | Fixed | In case a macro rende= ring a code snippet signals illegal arguments, that exception must not be w= ritten to the log. |
The following doctype add-ons are recommend= ed to be updated for the projectdoc Toolbox.
All doctype add-ons are optional. In case a= n add-on is not installed, there is no need to install it for this version = of the projectdoc Toolbox.
The following changes are part of the latest Core Doctypes Add-on.&nb= sp;
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDCORE= D-255 | Provide Doctype per Pa= rameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
||
PDCORE= D-257 | Compatibility Update f= or Version Doctype | Done | Fixed | The update is require= d for projectdoc Toolbox 4.2. The update sets a property to control the cre= ation of correct titles for the Version Doctype. |
||
PDCORE= D-256 | Fix I18N key for "Sour= ce" | Done | Fixed | The resource doctype = provides a property named "Source" with a copy-paste issue in its I18N key.= The key 'projectdoc.doctype.resource.quelle' needs to be renamed to 'proje= ctdoc.doctype.resource.source'. |
The following changes are part of the latest Doctypes for Agile Planning= .
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAGILE= -84 | Provide Doctype per Par= ameter | = | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
The following changes are part of the latest projectdoc Developer Diaries= a>.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
DEVDI= ARY-120 | Provide Doctype per P= arameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
The following changes are part of the latest Doctypes for Project Manage= ment.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDPRJ= MGMT-67 | Provide Doctype per P= arameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
The following changes are part of the latest Doctypes for Service Manage= ment.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
SERVIC= ES-15 | Provide Doctype per Pa= rameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
||
SERVIC= ES-13 | Support Short Name Que= ries | Done | Fixed | Allow to query for Na= mes and Short Names alike with type doctypes. |
||
SERVIC= ES-14 | Support empty Aside Pa= nels | Done | Fixed | Redesign the integrat= ion of the Aside Panel Macro to allow hiding empty panels. |
||
SERVIC= ES-12 | Add IDs Home/Index Pag= e Boxes | Done | Fixed | The boxes on home pag= es and index pages need to provide a unique identifier to refer to these bo= xes individually from CSS. |
The following changes are part of the latest Doctypes for Business Strate= gy.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
STRATE= GY-16 | Provide Doctype per Pa= rameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
||
STRATE= GY-15 | Support empty Aside Pa= nels | Done | Fixed | Redesign the integrat= ion of the Aside Panel Macro to allow hiding empty panels. |
||
STRATE= GY-13 | Add IDs Home/Index Pag= e Boxes | Done | Fixed | The boxes on home pag= es and index pages need to provide a unique identifier to refer to these bo= xes individually from CSS. |
||
STRATE= GY-14 | Support Short Name Que= ries | Done | Fixed | Allow to query for Na= mes and Short Names alike with type doctypes. |
The following changes are part of the latest Software Development Doctypes= .
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDSWD= EVD-136 | Provide Doctype per P= arameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
The following changes are part of the latest Doctypes for Teamwork.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDTE= AMWORK-23 | Provide Doctype per = Parameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
The following changes are part of the latest Doctypes for V-Modell XT.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDVMXT-2= 4 | Provide Doctype per Para= meter | <= /a> | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
The following changes are part of the latest projectdoc Add-on for arc42= .
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
ARCF= OURTWO-71 | Provide Doctype per = Parameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. Requ= ires the projectdoc Toolbox 4.2. |
||
ARCF= OURTWO-68 | Support empty Aside = Panels | Done | Fixed | Redesign the integrat= ion of the Aside Panel Macro to allow hiding empty panels. |
||
ARCF= OURTWO-67 | Add IDs Home/Index P= age Boxes | Done | Fixed | The boxes on home pag= es and index pages need to provide a unique identifier to refer to these bo= xes individually from CSS. |
||
ARCF= OURTWO-69 | Remove hard-coded In= tro Text | Done | Fixed | By removing the hard = coded intro text the boxes on the Home and Index Pages are shorter. |
The following changes are part of the latest projectdoc for Java Develope= rs.
This extension is experimental.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDJAV= ADEV-25 | Provide Doctype per P= arameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. <= p>Requires the projectdoc Toolbox 4.2. |
||
PDJAV= ADEV-26 | Compatibility Update = for Version Doctype | Done | Fixed | The update is require= d for projectdoc Toolbox 4.2. The update sets a property to control the cre= ation of correct titles for the Version Doctype (used by the Space Blueprin= t). |
The following changes are part of the latest projectdoc for Maven Develo= pers.
This extension is experimental.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDMVND= EV-22 | Provide Doctype per Pa= rameter | Done | Fixed | Define the doctype pr= operty as macro parameter instead of as a row in the properties table. <= p>Requires the projectdoc Toolbox 4.2. |
||
PDMVND= EV-25 | Compatibility Update f= or Version Doctype | Done | Fixed | The update is require= d for projectdoc Toolbox 4.2. The update sets a property to control the cre= ation of correct titles for the Version Doctype (used by the Space Blueprin= t). |
||
PDMVND= EV-23 | Create Space Blueprint= s | Done | Fixed | Soy template uses out= dated blueprint keys. |
||
PDMVND= EV-24 | SwDev Create Labels = a> | Done | Fixed | Fix the keys to creat= e button labels for template imported from the SWDEV add-on. |