- Created by Robert Reiner on 29. Apr 2020
projectdoc Toolbox
Announcements communicate with stakeholders information about a service.
- ID
service-announcement- Suite
- Parent
- Documentation Type
- Categories
- Since
- 3.2
Properties
The document type service-announcement 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.
Superordinate Service Announcements
Service Announcements may be composed. This is a reference to the superordinate service announcement.
The value is typically automatically provided by the parent document.
Type
Specify the type of this service announcement for categorization.
Use the Service Announcement Type Doctype to define types of service announcements.
IT Services
List the services that are related to this announcement.
Release Date
Specify the date of the release of this announcement.
In case the
Start
Specify the start date when this announcement is taking effect. This defines the starting point of the Duration.
End
Specify the start date when this announcement is taking effect. This defines the end point of the Duration.
Source
Add links to documents that provide more information.
Contact
Log a reference to a stakeholder, with whom stakeholders may get in touch for further information for this announcement.
Sections
Description
Describe the purpose of this announcement.
Summary
Summarize the content of the announcement.
This message is presented in a message box on landing pages.
Show Announcements
The following provides an example configuration to render announcements.
<ac:structured-macro ac:name="projectdoc-content-marker">
<ac:parameter ac:name="id">announcements</ac:parameter>
<ac:rich-text-body>
<ac:structured-macro ac:name="projectdoc-transclude-documents-macro">
<ac:parameter ac:name="doctype">service-announcement</ac:parameter>
<ac:parameter ac:name="where">$<Start§> <= ${now("", "+1w")} OR ($<Start§> < ${now} AND $<End§> > ${now})</ac:parameter>
<ac:parameter ac:name="sort-by">Start§, End§, Name</ac:parameter>
<ac:parameter ac:name="ids">Summary</ac:parameter>
<ac:parameter ac:name="render-document-name-as-heading">false</ac:parameter>
<ac:parameter ac:name="render-no-hits-as-blank">true</ac:parameter>
<ac:parameter ac:name="remote-controls">more:force-show=true</ac:parameter>
<ac:parameter ac:name="force-show">true</ac:parameter>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
This configuration takes advantage of Remote Control to show a link to the announcement that is hidden on the source.
<ac:structured-macro ac:name="projectdoc-content-marker">
<ac:parameter ac:name="hide">true</ac:parameter>
<ac:parameter ac:name="id">more</ac:parameter>
<ac:rich-text-body>
<ac:link>
<ri:page ri:content-title="<THIS ANNOUNCEMENT>"/>
<ac:plain-text-link-body>
<![CDATA[More information ...]]>
</ac:plain-text-link-body>
</ac:link>
</ac:rich-text-body>
</ac:structured-macro>
Related Work Instructions
List related work instruction that share the same target.
A Display Table Macro adds related work instructions automatically.
Since 3.2
This section is available since version 3.2.
Subordinate Work Instructions
Complex or long work instructions may be broken into several separate work instruction document instances.
As long as the work instruction is not shared by two parent work instructions, these instructions should be added as children to this document. Otherwise put it on the homepage of work instructions.
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.
