Go to start of metadata
- Created by Robert Reiner on 09. May 2019
Section Index
List of all sections.
| Name | Short Description | Parent |
|---|---|---|
| Discoverybility Example | An example of a simple type-like doctype. | Doctype Descriptor |
| Doctype with Type Example | An example of a doctype with a doctype-specific type. | Doctype Descriptor |
| Deleting Properties | Delete properties for a set of documents specified by their IDs. | Documents Service / PATCH |
| Description | Describes the content and the intention of the document instance. This is a longer form of the short description document property. | |
| Doctype | Identifies the type of the document. | |
| Download 5.0 Artifacts | Beta artifacts are not supported. Use at your own risk! Only for development environments. Upgrades or downgrades to other versions may not be supported. | projectdoc Toolbox 5.0 Release Notes |
| Fetching Document IDs | Specify a query to fetch document IDs. Pass this list of IDs to other service calls (e.g. to patch properties or sections). | Documents Service / GET |
| Security View Example | A more detailed doctype declaration with non-standard properties and sections. | Doctype Descriptor |
| Site refresh required | After import of a space, a reindex and in some cases a refresh page tree is required. | projectdoc Toolbox 2.5 Release Notes |
| smartics Exceptions | Library for Java to define exceptions and exception codes. This project addresses services for exception handling commonly required for applications, be them standalone or distributed multi-tier enterprise applications. | |
| Summary | An informative summary about the content of the document instance. This section is not meaningful to every document type. | |
| Documents | Section that lists documents associated by a name reference with this document instance. | |
| Children | Organizing documents in a hierarchical manner is sometimes very helpful to help readers to orientate in the documentation. The children section automatically lists the child documents, usually with the name and short description. | |
| Issues Maven Plugin | Generates reports on issues retrieved from an issue management system. Currently only Bugzilla is supported. | |
| Name | Every document instance requires a name that should uniquely identify it within its doctype. | |
| Short Name | A shorter or abbreviated name of the document. | |
| Bugzilla Maven Plugin | Administrates products on a Bugzilla server remotely. The information found in a project’s pom.xml is passed to the Bugzilla server. This lessens the burden of entering the project's information manually to the Bugzilla forms and makes it easy to update version numbers after a release. | |
| Notes | These are internal notes that are usually not exported and only visible to team members with write access. | |
| Short Description | The short description describes the content of the document. This information is typically displayed in document lists, where the name is rendered side by side with the short description. | |
| Alias Maven Plugin | Creates alias scripts from a configurations file. This allows a team to share aliases that are useful to make working with a command shell more productive. There is a report to generate a documentation for the shortcuts on your team server. | |
| Parent | The property references the higher ranked document, typically of the same type as the child document. Usually the parent is a more general form of the child or is in some other ways a structuring instance. | |
| References | For a document the references section contains pointers to resources that prove the statements of the document. | |
| Audience | The audience is the group of readers the document defines as it target. | |
| Hibernate 4 Maven Plugin | Provides a very simple way of generating DDL scripts from a JPA unit. It is therefore a very limited version of the hibernate3-maven-plugin. | |
| Resources | Provides references to further information to the topic of the document. | |
| Categories | Categories help to organize document instances in hierarchies. | |
| Subject | Subject properties allow to set document instance of different doctypes in a common context. | |
| Tagcloud Maven Plugin | Visualizes the frequency of use of words within a given set of texts. Usually they are used to give the visitor of a web site an impression of what the web site is about. | |
| Flags | Like Tags the document property Flags also supports labelling documents, but without the need to document them. | |
| Recode Maven Plugin | Allows to read project files in one encoding and write it to a destination in another encoding. | |
| Tags | Tags allow to add arbitrary character sequences to group document instances, even of different document types. On searches tags allow to select specific instances. | |
| APIDoc Maven Plugin | Provides a simple report generator containing the output of the Javadoc tool. On the one hand this allows to pinpoint problems in the Javadoc documentation to resolve. On the other hand it gives a report on the quality of the Javadoc comments of a project. | |
| Iteration | The Iteration property is a tool for the author to communicate the status of the document within its creation process. Readers get aware, how to interpret the information in the document. | |
| Sort Key | The sort key is the primary tool for sorting documents displayed in a list or on a table. Usually the documents are sorted by name, but sometimes you want to impose a semantic order on the documents. | |
| Type | The type property is a doctype specific category. | |
| Sponsors | References stakeholders who take interest in creating and optionally maintaining a document. | |
| Adding Properties | Add properties for a set of documents specified by their IDs. | Documents Service / PATCH |
| smartics Properties | A library for Java to declare and define properties and to access them from an application in a convenient way. | |
| Space cannot be deleted | Some spaces resist to be deleted. | projectdoc Toolbox 2.5 Release Notes |
| Testdoc Maven Plugin | Provides tools to generate documentation from tests. Currently the tools concentrate on making the story behind tests visible. They use the tests to generate a documentation from executable code. Since the test code itself is documentation, we talk about executable documentation. | |
| Hudson Maven Plugin | Deploys Hudson job configuration files to a running Hudson server. | |
| Create From Template Macro fails | Instead of creating a new document instance for a doctype, the template button macro only logs an error to the browser's console. | projectdoc Toolbox 2.5 Release Notes |
| Exception Codes Maven Plugin | Generates reports on exceptions codes of a project that uses smartics exceptions. | |
| smartics Commons | Contains utility classes for Java used in most of our projects. | |
| smartics JBoss Utils | Contains Java utilities to be used in a environment run by JBoss products. | |
| smartics Test Utils | Provides utility classes to make writing JUnit tests easier. | |
| Properties Maven Plugin | Generates reports on properties of a project that uses smartics properties. | |
| PMD Rules | Provides rules for PMD. | |
| Checkstyle Rules | Provides rules for Checkstyle. | |
| smartics Softlink Tool | Creates links for a project release following naming conventions. | |
| Overview | Overview over the chapters of the Software Architecture Documentation (SWAD). | Software Architecture Documentation |
| Transclusion of Hidden Sections | The handling of the transclusion of hidden sections has changed. As of this version, the section will no longer be transcluded. In a future version of the projectdoc toolbox, we will provide an option that allows transcluding hidden sections. In this version, it is necessary not to hide the section itself, but to surround it with a Content Marker Makro which itself is hidden. |
Need more Info?
More information on doctype:
Related Information
Related information in your wiki:
- Section Types
- Space Indices
- Generic Index
- Excerpt Index
- No labels
