Go to start of metadata
- Created by Robert Reiner, last modified on 04. Dec 2014
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Short Description | Experience to get the job done. Requires instructions to the point. |
---|---|
Iteration | Facade |
Topics
Name | Short Description |
---|---|
(Not) Using Templates with Variables | Shows what to expect when using variables in 'User Created Templates' or 'Global Templates'. |
Using Subdocuments with Transclusion | Instead of a table listing the name and properties of the subdocuments, transclude the content into the parent document. |
Autolists | Autolist macros allow to display a list of documents dependent on a set of properties. This screencast shows how to use the Display Table macro to select all documents tagged with a given keyword. |
Accessing projectdoc Properties with cURL | Learn how to access projectdoc properties via REST API with cURL. |
Accessing projectdoc Space Properties with cURL | Learn how to access projectdoc space properties via REST API with cURL. |
Agile Documentation | Agile documentation is not another buzzword. There is actually a set of rules to follow which will lead to meaningful documentation. Writing helpful documentation is not easy, but it gets a lot easier with the agile mindset - and with the projectdoc Toolbox. |
Annotate Dynamic Lists | It is pretty easy to annotate dynamic lists with the projectdoc Toolbox on Confluence. |
Compacted Lists | Discard unwanted references in manually compiled lists with the projectdoc Toolbox on Confluence. |
Configure Servers | Shows how to configure servers as profiles. This makes it easy to select a deployment target by selecting a profile. |
Content Reuse | The projectdoc Toolbox provides a number of features to help teams to reuse content. Content can be transcluded individually or in form of a multitransclude. Authors can even transclude content from multiple documents in the wiki, effectively combining transclusion with automatic lists. |
Define Status Tags | Doctypes and the Name List Macro allow to specify a range of valid tokens for a value. These values can be rendered by applying specific CSS styles. |
From a Table to Views | Short introduction on using data tables or using views on data. |
Heading Level Transposition | Reusing sections typically includes the transcluded content to match the document structure of the transcluding document. The projectdoc Toolbox does this automatically. |
Hide projectdoc Tools within Browser | The projectdoc Toolbox installs a lot of macros and additional doctype add-ons install a lot of doctypes. This tips shows ways that allow to remove the projectdoc tools from the current page. |
Highlights | Lost in wiki space? Blank-Wikipage-Syndrome? Where to add? How to find? No fun anymore? |
How to document a Software Development Project | There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence. |
HTML Title as Link Text | The Information Systems Extension for the projectdoc Toolbox allows to render a link with the HTML title as label via autoconvert of the pasted URL. |
Identifiers with Dots | Writing page blueprints includes to configure wizards for easy page creation. If the field identifier contains dots there is a problem with a simple solution. |
Installation Guide | Installing the projectdoc Toolbox on Confluence is very easy. |
List related Pages | Listing related pages to a page is quite easy using the projectdoc Toolbox. |
Macros Introduction | This is a gentle introduction to the core macros. The macros are grouped semantically to make it easier for users to build a conceptual mind map for them. |
Materialize Properties | Using existing properties from other documents. |
Modularization | Using sections and modules to organize and reference content. |
No dynamic Property Values | The projectdoc Toolbox does not support dynamic values as property values. Use sections to render dynamic values and select the contents of this section instead of property values. |
Project Settings | The project-settings.xml allows user specific defaults for parameter values used for the project creation process. |
Referencing Property Values | Shows how to render the value of a document property with a display macro. There are actually three variants of this macro that we are discussion in this short article. |
REST Login to Confluence with cURL | To access Confluence via its REST API with cURL you typically need to authenticate. Learn how to login with cURL and avoid some common security pitfalls. |
Search Filter based on Properties | Show how to use document properties to filter on searches. |
Search Functions | Using functions to run searches with the projectdoc Toolbox. |
Security Considerations | Userscripts for Confluence supports the execution of script code in the browsers of users. It is important to understand the use cases to understand security implications. |
Selection Boxes on ad-hoc Doctypes | Define a doctype on document instances to select from its set of values. |
Subtree Queries | The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in a document tree with a given root. |
Support Browsing | Tools from the projectdoc Toolbox to allow users to browse for information. |
The hidden Section | The Content Marker Macro identifies content that can be displayed using the Display Table Macro. This is a short tip on how to transclude content from a projectdoc document. |
Think Repositories | To organize your documentation place documents in a typed repository and add additional views on demand. |
Tips | List of tips to use Confluence with the projectdoc Toolbox and fun! Tips address users of different experience levels. |
Using projectdoc to document Maven Plugins | We decided to move our documentation from the XDoc format to projectdoc on Confluence. This allows us to update the information independent of the release cycles of the products. Here are some tips on how to use projectdoc for this task. |
Using Space Properties | Space properties are defined for spaces and are accessed via the Space Property Macro. This tip goes into detail in how to use space properties with inheritence and extension pages. |
Using Spaces | A short introduction on using spaces with the projectdoc Toolbox for Confluence. |
Using Variables | Using document and space properties as variables in the projectdoc Toolbox for Confluence. |
Views on Topics | projectdoc makes it easy to create a modular documentation and provide multiple views on topics. |
Web of Documents | The projectdoc Toolbox makes it easier to create links for navigation for users to browse the documentation. This tip explains some the concept in the context of organization, person, role, and stakeholder. |
- No labels