projectdoc Toolbox

Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format.

ID
resource-type
Suite
Documentation Type
Categories
Tags
Target Types

Description

Allows grouping resources by type, the resource type also helps readers to set their expectations of the resource document's content.

Since 11.1.0

 

Since version 11.1.0 of the Core Doctypes this property is purely semantic.

Use Media Type to document the format of a resource.

Properties

The document type resource type provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Sections

Description

A detailed description of the resource type.

This helps authors to select the appropriate type for their resources.

Subordinate Resource Types

Group resource types by putting them in a hierarchy.

Resources of this Type

An overview over resources of this type.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.

Details

Resource Type Macro

Related Doctypes

Here is a list of related doctypes that define types for categorization of document instances:

Name Short Description Set Target Types
Categorize associations by a type.
Categorize categories by a type.
Categorize charters by a type.
Categorize excerpts by a type.
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
Categorize experience levels by a type.
Categorize FAQs by a type.
Categorize generic documents by a type.
Categorize glossary items by a type.
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
Categorize media types by their type.
Categorization of document modules for single sourcing.
Categorize organizations by a type.
Categorize persons by a type.
Categorize profiles by a type.
Categorize quotes by a type.
Organizes glossary items.
Categorize relations by a type.
Categorize roles by a type.
Categorize sections by a type.
Categorize space indexes by a type.
Categorize stakeholders by a type.
Categorize steps by a type.
Categorize subjects by a type.
Categorize tags by a type.
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
Categorize versions by a type.

Resources

  • Resource Types - examples of document instances for use in your project.