Go to start of metadata
- Created by Robert Reiner on 06. Oct 2019
projectdoc Toolbox
The projectdoc Toolbox supports agile teams in technical communication and creating and maintaining documentation for projects and products collaboratively.
Related Indices
- projectdoc Toolbox
- Userscripts to be used in the context of the projectdoc Toolbox.
Documents
Documents in your wiki concerned with this tag.
| Name | Short Description | Doctype | Creation Date | Last Modification Date |
|---|---|---|---|---|
| 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. | topic | ||
| Ancestor Queries | The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in an ancestor context. | topic | ||
| Annotate Dynamic Lists | It is pretty easy to annotate dynamic lists with the projectdoc Toolbox on Confluence. | topic | ||
| Aspects light | Add a document as a child and automatically make supplied properties available in the parent. | topic | ||
| Being a Pretender | Authors occasionally need to have a look at a page as if they where in the role of a reader. The pretend-being-a user space property supports switching roles. With the use of the Web API Extension and the Bookmarklets Extension switching roles is now really easy! | topic | ||
| Changing Names | A name in projectdoc used to identify a document is not considered a hard reference. When changing the name of a particular document, the references to the original name do not automatically change. This is by design. It may also by the cause of annoyance. This tip provides information how to deal with this. | topic | ||
| Compact Columns | Tables often require a lot of space to be rendered. This tip shows how to reduce the demand of space. | topic | ||
| Compacted Lists | Discard unwanted references in manually compiled lists with the projectdoc Toolbox on Confluence. | topic | ||
| Confluence as the Information Hub | Tools from the projectdoc Toolbox to import from and export to other information systems. | topic | ||
| Control Column Width with Display Table Macro | The Display Table Macro provides a quick fix feature to control the width of the table columns. | topic | ||
| Create Doctypes with a Model | A short introduction the the Doctype Maven Plugin to generate Confluence Blueprints for projectdoc Doctypes based on an XML description. | topic | ||
| Doctypes | Doctypes define properties and sections for documents. They are essentially Confluence Blueprints that help to create pages in your wiki based on templates. | docsection | ||
| Empty Content | Introduces to the concept of content to be considered to be empty. | topic | ||
| From a Table to Views | Short introduction on using data tables or using views on data. | topic | ||
| 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. | topic | ||
| Hide projectdoc Tools | Removes projectdoc tools (blueprints and macros) from the current page. | app-script | ||
| 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. | topic | ||
| 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. | topic | ||
| 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. | topic | ||
| Impersonator - using Live Templates | A short introduction using the impersonator feature of the projectdoc Toolbox. In this example we examine what to do to reuse a layout defined in another document. | topic | ||
| Increasing the Document Cache | If you have lots of projectdoc documents then the in-memory properties cache might not perform optimal. | topic | ||
| Inspect Menu for projectdoc | Renders a menu with tools to inspect information from a projectdoc document, shown in the browser. | app-script | ||
| Learning projectdoc | Getting started with the projectdoc Toolbox is not easy. Some basic concepts are more than just good-to-know and the number of macros and doctypes may be simply overwhelming. This tip gives some advice on how to get started. | topic | ||
| Linking to Glossary Terms | Show how to use the Name List Macro to render links to glossary terms. | topic | ||
| Macros | List of macros provided by the projectdoc Toolbox. | docsection | ||
| Modularization | Using sections and modules to organize and reference content. | topic | ||
| 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. | topic | ||
| Parent Property of projectdoc Documents | projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about. | topic | ||
| projectdoc Extensions | Extensions augment the projectdoc Toolbox. Features that are not relevant for all users are separated and may be installed on-demand by customers of the Toolbox. | topic | ||
| projectdoc Search Tool | Provides an interface to specify and launch queries for projectdoc documents. | app-script | ||
| Refactor projectdoc Document | Adds a refactor menu and checks the current document for property issues. | app-script | ||
| Rendering Navigation Links | There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox. | topic | ||
| Reporting | A short introduction on compiling projectdoc documents in dynamic lists using constraints. | topic | ||
| Search Filter based on Properties | Show how to use document properties to filter on searches. | topic | ||
| Search Functions | Using functions to run searches with the projectdoc Toolbox. | topic | ||
| Search Space for Index Spaces | Define the default search space for index spaces. | topic | ||
| 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. | topic | ||
| Supply Documents | Show how to import properties from other projectdoc documents into a projectdoc document. | topic | ||
| Support Browsing | Tools from the projectdoc Toolbox to allow users to browse for information. | topic | ||
| Toggle Views | Shows how to use the Wiki Link Macro based on Remote Controls to alternate between two different views on a single document. | topic | ||
| Topic is not meant to be multi-purpose | Despite the name of the Topic Doctype, it is not supposed to be used for any topic. Use the Generic Doctype or the Section Doctype for general purposes. | topic | ||
| Two central Use Cases for the projectdoc Toolbox | The projectdoc Toolbox provides a lot of macros to create documentation. It also replaces two macros provided by Confluence. The Excerpt Macro and the Page Properties Macro. | topic | ||
| Use Cases | An overview over the use cases for which the projectdoc Toolbox provides support. | topic | ||
| User Documentation for Maven Plugin | Provide a standard documentation for users of a plugin for Maven. | business-use-case | ||
| Using Aspects | Add a document as a child and automatically make supplied properties and sections available in the parent. A short walk-through to use the Aspect Feature in your information architecture. | topic | ||
| Using Commas in Property Values | Property values are inherently considered to be a list of strings. Typically this a good thing since it makes working with list of names very easy. Sometimes it makes things more difficult. | topic | ||
| Using Spaces | A short introduction on using spaces with the projectdoc Toolbox for Confluence. | topic |
