This document discusses utilities in Unity training course V2.0 module 3.G, including how to build and print documentation for a project, and create hyperlinks between the project and external documents. It covers generating documentation by defining things like the title page, footer, and headings; and creating hyperlinks from the project browser or comment fields that can link to files, web pages or images when clicked.
2. Unity training cours V2.0 - module 3.G : Utilities 3
Summary
Documentation
Build and print the documentation of the project
Hyperlink
Create links between the project and external documents
3. Unity training cours V2.0 - module 3.G : Utilities 4
Documentation overview
Build the documentation file for the project
Print this documentation file in full or in part once
it is built
From the project browser, access to the
Documentation directory and open it
Display the documentation file in 2 different
forms :
structural view
functional view
4. Unity training cours V2.0 - module 3.G : Utilities 6
Title page and General information
Define the project name and the designer
Double-click on Title Page in the
Documentation folder of the project
browser
Enter general information of the project
Double-click on General Information in the
Documentation folder of the project
browser
Enter the comment text and/or hyperlink
5. Unity training cours V2.0 - module 3.G : Utilities 7
Generation
Open the Documentation browser
Define the footer
Select the path for a bitmap file for printing
a logo
Enter the author and departement
Enter the industrial property
Enter two spare fields
Include headings to define the documentation
content (Right-click on the item)
Build the documentation
Print the documentation
6. Unity training cours V2.0 - module 3.G : Utilities 8
Hyperlinks overview
Function available in Unity Pro to create links between the project
and external documents
Create hyperlinks in the project browser like shortcut sheets in all the
directories and sub-directories
Create hyperlinks from a comment field :
data editor variables and animation tables in comment
runtime screen in text field
documentation in General information heading
Different hyperlink targets depending on the file extensions :
*.doc or *.xls : Microsoft Word or Excel
*.txt : Notepad
*.htm, *.html, *.asp or *.shtml : WEB browser
*.bmp, *.jpg, *.gif or *.png : image
7. Unity training cours V2.0 - module 3.G : Utilities 9
Operating mode
Creating of a hyperlink
In the project browser
In comment field
Opening a hyperlink by double-click on (from
the project browser, data editor) or single click
(from runtime screen, documentation)
Editing the properties of a hyperlink by right-
click => Properties
Deleting a hyperlink by right-click => Delete
