Go to start of metadata
- Created by Robert Reiner, last modified on 16. Sep 2019
No prior experience.
Topics
| Name | Space | Short Description |
|---|---|---|
| Document Types and Templates | projectdoc Toolbox | Document types (or doctypes for short) define a set of properties and sections. Each doctype matches at least one Confluence Page Blueprint. Confluence Page Blueprints are a collection of templates, but often the collection contains only one element. |
| Document Properties | projectdoc Toolbox | Properties are metadata that can be added to every projectdoc document. If you require a set of metadata for each instance of a document type, you should write your own doctype. |
| Document Sections | projectdoc Toolbox | The main body of a document is divided into sections. Besides the sections defined by a doctype, an author may add any number of additional sections. Sections that are regularly added to a given doctype should be added to the doctype's template. |
| Name and Title | projectdoc Toolbox | The purpose and the differences between the name and title property of a doctype. |
| Writing Short Descriptions | projectdoc Toolbox | Benefits of and tips on writing short descriptions. |
| Tagging Documents | projectdoc Toolbox | Techniques to tag content with arbitrary labels: Tags, Labels, Flags, and Selectors. |
| Using Sort Keys | projectdoc Toolbox | Sort keys help to control the sort order of a set of documents. This order seems to come magical for users, since the sort key is usually not displayed. The order establishes a path to a set of documents displayed as a list as the result of a query. |
| Headings | projectdoc Toolbox | Discussion on whether or not to use more than one heading on level 1. |
| projectdoc Introduction | projectdoc for Atlassian Confluence | A short introduction into the concepts and features of the projectdoc Toolbox. |
| References and Resources | projectdoc Toolbox | References are links to information that back up the information in this document. Resources refer to additional information to the topic discussed in the document and related information. |
| Create a Space | projectdoc Toolbox | Start with projectdoc by creating a space with the standard blueprint. |
| Create an Index Space | projectdoc Toolbox | Create an index space to learn what it is and what it is used for. |
| Generic Categories | projectdoc Toolbox | Categories that are defined to be used with any doctype. So any document instance defined for these categories has to make sense for any doctype. |
| projectdoc Document | projectdoc Toolbox | projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections. |
| Referencing Macros | projectdoc Toolbox | Macros to help authors to reference other documents that are relevant to the current document. |
| Create an Attachment Space | projectdoc Toolbox | Organized information of a context, such as a glossary or an address book, in a dedicated space. These spaces are called attachment spaces. |
| Micro Structure | projectdoc Toolbox | A template assists authors in writing documents of a given type. Templates help that documents are similar in structure and therefore are also easier to read by members of the project team. projectdoc only renders table rows and sections, if they actually contain information. This reduces clutter to distract readers. |
| Create a Personal Space | projectdoc Toolbox | Adjust your Confluence personal space to work as a personal space for projectdoc. |
| projectdoc Space Relationships | projectdoc Toolbox | projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search. |
| Structuring Macros | projectdoc Toolbox | Macros to help authors to a document structure so that the information is easier to understand. |
| Using Roles | projectdoc Toolbox | Add roles to your space and set the audience of a topic document to one of the roles. |
| Create a Workspace | projectdoc Toolbox | Create a space to work on a given topic. This spaces uses an index space to reuse content. |
| Home and Index Pages | projectdoc Toolbox | Home and index pages help to organize documents by type. For each doctype there is a homepage and and index page. The homepage shows the central documents that are added to it (immediate children). Index pages list all documents of the space, regardless of their location. |
| Modular Documentation Macros | projectdoc Toolbox | Macros to support single sourcing for creating modular documents. |
| Doctypes in Detail | projectdoc Toolbox | Learn about properties and sections of a document. |
| Edit Display Table | projectdoc Toolbox | The Display Table Macro allows to specify queries on documents. The documents are listed in a tabular form per default. Authors declare the document properties to be displayed in the columns of the table |
| Modular Content Doctypes | projectdoc Toolbox | Doctypes that help to write modular documentation and therefore support single sourcing. |
| Visual Macros | projectdoc Toolbox | Macros to render information in a visually appealing format. |
| Add Display Table Macro | projectdoc Toolbox | Authors use the Display Table Macro to list documents that match a query. This screencast shows how to add one to a document. |
| Document Development Macros | projectdoc Toolbox | Macros that help authors to create templates and content. |
| Documenting Doctypes | projectdoc Toolbox | These are the generic working horses that are used whenever no specific doctype matches the intention of the author. |
| The Workhorse Macros | projectdoc Toolbox | Learn about the central most heavily used macros of your projectdoc Toolbox. |
| Add Excerpts to a Resource | projectdoc Toolbox | Resources describe relevant information for a project. The essential parts are noted to make it easier for finding the most relevant parts quickly. Excerpts allow to add the information as subdocuments. |
| Categorization | projectdoc Toolbox | Organize your spaces with generic and specialized categories. |
| Collaboration Macros | projectdoc Toolbox | Macros to support a team to write their documentation collaboratively. |
| Subordinate Documents | projectdoc Toolbox | Subdocuments are associated with the lifetime of the parent document. The section doctype is the most generic type of document, but there are others, that are specific to a certain doctype. |
| Specific Doctypes | projectdoc Toolbox | A list of doctypes that have a specific purpose. The core doctypes are none-the-less quite generic so that they can be used in almost any project. |
| Using Subdocuments | projectdoc Toolbox | The lifetime of a subdocment is associated with that of its parent. Subdocuments help to organize content within a document by externalizing it. This makes it easier for teams to work on a document together. Referencing parts of the document is also easier. |
| What's next? | projectdoc Toolbox | Checkout further resources on working with projectdoc. |
| Generic Doctypes | projectdoc Toolbox | What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation. |
| Query Configuration | projectdoc Toolbox | Controls the parameter to use for running queries with the projectdoc Toolbox. |
| Dynamic Property Value Handling | projectdoc Toolbox | Configuration to control how the projectdoc Toolbox handles property values with dynamic content. |
| Additional Properties | projectdoc Toolbox | Sometimes you need to add properties to a set of documents in a given context. This can be handled in two ways: add the property to each document or use the Tour Macro. |
| Alternatives to Userscripts for Confluence | Userscripts for Confluence | Userscripts for Confluence is one way to implement userscripts for users of a Confluence server. This article introduces alternatives. |
| Basic Concepts and Conventions for projectdoc | projectdoc Toolbox | Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc. |
| Colored Sections and Boxes | projectdoc Toolbox | Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content. |
| Compact Columns | projectdoc Toolbox | Tables often require a lot of space to be rendered. This tip shows how to reduce the demand of space. |
| Compare with built-in Features | projectdoc Toolbox | Compare the features provided by the projectdoc Toolbox with features that come with Confluence out-of-the-box. |
| Configuration | projectdoc Toolbox | Information for the configuration options of the projectdoc Toolbox. |
| Control Column Width with Display Table Macro | projectdoc Toolbox | The Display Table Macro provides a quick fix feature to control the width of the table columns. |
| Definition List Macro in Action | projectdoc Toolbox | Screencast to show how the Definition List Macro is used to create definition lists in Confluence. |
| Doctypes Introduction | projectdoc Toolbox | A gentle introduction to page blueprints provided by doctype add-ons. The page blueprints are grouped semantically to make it easier for users to build a conceptual mind map for them. |
| Document Properties as Data | projectdoc Toolbox | We like to think of document properties as metadata. But in some contexts it is natural to think of them as data for the entity described by the document. |
| Download | Projectmetadata Maven Plugin | Instructions on how to download the artifact of the Projectmetadata Maven Plugin. |
| Download | smartics Enforcer Rules for Maven | Instructions on how to download the library artifact of the smartics Enforcer Rules for Maven. |
| Download | Apptools Maven Plugin | Instructions on how to download the artifact of this project. |
| Download | Doctypes Maven Plugin | Instructions on how to download the artifact of this project. |
| Dynamic Property Values | projectdoc Toolbox | Property values should only change when a document is saved. They should not be dependent on request-time. If they are, then they are called 'dynamic'. |
| Evaluation Topics | projectdoc Toolbox | Provides information about features potential users should consider for their evaluation process on using the projectdoc Toolbox for Confluence. |
| Hands-on Tutorial | projectdoc Toolbox | Get started with the projectdoc Toolbox: learning by doing |
| Writing Userscripts | Userscripts for Confluence | A short introduction to write userscripts for the Userscripts for Confluence App. |
| Managing Userscripts | Userscripts for Confluence | A short introduction to manage (add, alter, remove) userscripts with the Userscripts for Confluence App. |
| Introduction for new Users | projectdoc Toolbox | Provides information to get new users of projectdoc get started with projectdoc documents and spaces. |
| Learning projectdoc | projectdoc Toolbox | 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. |
| Limitations on Query Results | projectdoc Toolbox | The number of hits for document queries is limited due to performance reasons. |
| List all Properties | projectdoc Toolbox | projectdoc provides a number of artificial properties for documents. Spaces may inherit properties from delegate spaces. All properties can be accessed by macros of the toolbox. |
| Merging Tables and Lists | projectdoc Toolbox | References listed in tables and lists may come from different sources. The Table Merger Macro allows to render a number of tables (or lists) as one table (or list). |
| Parent Property of projectdoc Documents | projectdoc Toolbox | projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about. |
| Prerequisites | Doctypes Maven Plugin | The plugin is part of a development process. Therefore there are some prerequisites to get started. |
| projectdoc in Action | projectdoc Toolbox | Screencasts to introduce to the concepts and workings of projectdoc. Users get an impression on how projectdoc works and find information on its concepts. |
| projectdoc Model Descriptors | Doctypes Maven Plugin | Provides an overview over the model descriptors to describe the add-on, spaces, and doctypes. |
| Rendering Navigation Links | projectdoc Toolbox | There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox. |
| Reporting | projectdoc Toolbox | A short introduction on compiling projectdoc documents in dynamic lists using constraints. |
| Section in Action | projectdoc Toolbox | Use the Section Macro to define sections. This tip introduces the macro by listing its features. |
| Spaces Introduction | projectdoc Toolbox | Provides a gentle introduction to the concept of spaces using projectdoc. |
| Think big, start small | projectdoc Toolbox | Starting with the projectdoc Toolbox might be intimidating at first. So start small using the basic features and add what is needed, when it is needed. |
| Topic is not meant to be multi-purpose | projectdoc Toolbox | 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. |
| Two central Use Cases for the projectdoc Toolbox | 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. |
| Usage | Doctypes Maven Plugin | List of usage scenarios creating blueprints with the plugin for Maven. |
| Using Commas in Property Values | projectdoc Toolbox | 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. |
| Views on Documents | projectdoc Toolbox | Switch views on documents dependent on the user's role by setting space properties in the user's homepage. |
