Managing an Artidoc file

Configure an Artidoc

At the top of your document, you will find several tools to help organize your writing:

• Make text bold or italic.

• Create bulleted or numbered lists.

• Add or remove a link.

• Insert an image.

• And more…

On the right, you will also find the table of contents, which automatically fills as you write your document. When it becomes long, simply click on a section title, and Tuleap will take you directly to that section.

Thanks to the three small dots at the top, you also have the option to open your Artidoc in full screen and access additional configuration options.

The “Tracker selection” tab allows you to change the tracker on which your Artidoc is based without deleting the artifacts created from the document. You retain all your content that was based on the previous tracker.

The “Field Selection” tab becomes active once you have at least one artifact created in your Artidoc document. This tab allows you to choose which fields you want to display in your Artidoc.

The fields selected in this example appear clearly in my Artidoc under my first bug. They automatically update in your Artidoc if they are changed directly in the tracker.

The “Experimental features” tab allows you to contribute to the improvement of Artidoc by testing version displays and providing feedback to the Tuleap teams. Simply click the button to activate the feature.

Information

The data displayed will be fictitious until the feature has been fully completed by our teams.

Writing in Artidoc

Using the small “+” button, you can start adding elements to your document:

• Free text: This allows you to write any text not linked to any element or artifact.

• Create a “tracker name” artifact: This allows you to create an artifact (in this example, a bug) directly from your Artidoc document. You will find this artifact and all its elements in the dedicated tracker.

• Import a “tracker name” artifact: This allows you to import an existing artifact from the tracker on which your Artidoc is based, in order to include it in the documentation.

Writing free text in Artidoc

Creating an artifact from Artidoc

Importing an artifact into Artidoc

For each artifact in your document, whether created from a file or imported, you can access its information directly from your Artidoc document.

Reorganize your Artidoc

From the table of contents, you can drag and drop items to rearrange your document.

Deleting items in Artidoc

You can delete an item without any problem, but be careful, deleting free text is permanent.

Deleting an artifact only removes it from your Artidoc document. The artifact itself remains intact and can still be accessed in your dedicated tracker.