TimBox is a tool for authoring technical documents that focuses on organizing content by meaning rather than document structure or layout. It allows users to create reusable content modules, structure information into tasks and sections, and define relationships between different content types. Documents can then be published in various formats or exported to standardized XML formats through stylesheet application and content transformation. The tool aims to make technical writing more modular, reusable, and less tied to specific document outputs.
2. What makes generating XML content with TimBox convenient?
AUTHORING PROFILING PUBLISHING CONVERTING SHARING
Content-centred authoring Choice of the content Defining layout by means Exporting to Disseminating
instead of document- to be included in of stylesheets and standardized XML documents on DropBox
oriented authoring document releases publishing in any format formats (DITA) and Wikimedia
and …
no XML tag manipulation whatsoever
4. AUTHORING
Organise content on the basis of meaning [Wysiwym], not of layout [Wysiwyg]
Most technical documents contain mainly procedures. Procedures are made out of tasks. Therefore,
tasks are the most natural unit to organise content within technical documents
This is a TimBox
Task Hierarchy
MEANING-
CENTRED DESIGN
5. AUTHORING
Organise content on the basis of meaning [Wysiwym], not of layout [Wysiwyg]
Most technical documents contain mainly procedures. Procedures are made out of tasks. Therefore,
tasks are the most natural unit to organise content within technical documents
This is a TimBox
Task Content
MEANING-
CENTRED DESIGN
6. AUTHORING
Organise content on the basis of meaning [Wysiwym], not of layout [Wysiwyg]
Most technical documents contain mainly procedures. Procedures are made out of tasks. Therefore,
tasks are the most natural unit to organise content within technical documents
These are TimBox
Task Types
The quality of a task-structure depends on the
distinctions between task types. Being able to identify
conditional tasks, optional and mandatory sub-tasks,
tasks that have to be performed several times to
reach the goal [cyclic tasks], etc. is a requirement for
a sound description of how work has to be performed.
MEANING- TimBox is the only software
CENTRED DESIGN to allow such distinctions.
7. AUTHORING
Organise content on the basis of meaning [Wysiwym], not of layout [Wysiwyg]
Although tasks are the default content of manuals and any type of instructions,
descriptions and explanations are also necessary in technical documents
These are TimBox
containers for unstructured
information
MEANING-
CENTRED DESIGN
8. AUTHORING
Create reusable content
Reusable tasks can be stored in the task library and are available for any project.
TimBox stores
reusable Tasks here
INFORMATION
REUSE
9. AUTHORING
Create reusable content
Reusable text can be stored in the Repository and is available for any project.
TimBox stores
reusable text here
INFORMATION
REUSE
10. AUTHORING
Create reusable content
Reusable information structures can be stored in the Related Information Library and are available for any project.
They allow to add auxiliary information to task and to task-independent containers
TimBox stores
reusable information
structures here
INFORMATION
REUSE
11. AUTHORING
Create content as small units [modules], not as whole documents
MODULARITY
task modules unstructured info modules expressions structures for auxiliary info
12. AUTHORING
Reuse existing content
MODULARITY
copy and clone tasks in the hierarchy drag and drop library elements onto the task hierarchy and into the task content
tasks and unstructured info modules expressions structures for auxiliary info
13. AUTHORING
Write after models of content, not after models of documents
CONTENT
STRUCTURING
WORK
Task Task Task
Task
pre-
input output side-effect procedure
condition
• action
• action
• action
14. AUTHORING
Define the structure of the content, generate the structure of documents
CONTENT
STRUCTURING
15. UPDATING
Update units of content instead of updating whole documents
Add, delete, modify, re-order tasks and or sections and re-publish the document
tasks sections
16. PROFILING
Select created content for delivery instead of creating content for final documents
While publishing a document or sharing it, you can choose the desired content by blocks
17. PUBLISHING
Apply stylesheets to obtain different layouts for the same document content
18. PUBLISHING
Enable publishing of documents in different formats [PDF, RTF, XML, HTML, CHM ...]
19. CONVERTING
Enable XML content transformation into standardized formats [DITA, DOCBOOK ...]
20. SHARING
Share sources and documents on clouds and wikis