Skip to content

Commit 4b8f529

Browse files
committed
Update readme for v1.2
1 parent 95e0084 commit 4b8f529

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ This project and the following release notes have been migrated from the old Ara
1414

1515
Release | Notes
1616
--------|--------
17+
[v1.2](https://github.com/ArasLabs/custom-tech-docs/releases/tag/v1.2) | Adds template functionality.
1718
[v1.1](https://github.com/ArasLabs/custom-tech-docs/releases/tag/v1.1) | Fixes an import error.
1819
[v1.0](https://github.com/ArasLabs/custom-tech-docs/releases/tag/v1.0) | First release. Though built and tested using Aras 11.0 SP9, this project may function in older releases of Aras 11.0.
1920

2021
#### Supported Aras Versions
2122

2223
Project | Aras
2324
--------|------
25+
[v1.2](https://github.com/ArasLabs/custom-tech-docs/releases/tag/v1.2) | 11.0 SP9
2426
[v1.1](https://github.com/ArasLabs/custom-tech-docs/releases/tag/v1.1) | 11.0 SP9
2527
[v1.0](https://github.com/ArasLabs/custom-tech-docs/releases/tag/v1.0) | 11.0 SP9
2628

@@ -41,15 +43,15 @@ Project | Aras
4143
1. Backup your database and store the BAK file in a safe place.
4244
2. Open up the Aras Package Import tool.
4345
3. Enter your login credentials and click **Login**
44-
* _Note: You must login as root for the package import to succeed!_
46+
* _Note: You must login as root for the package import to succeed!_
4547
4. Enter the package name in the TargetRelease field.
46-
* Optional: Enter a description in the Description field.
48+
* Optional: Enter a description in the Description field.
4749
5. Enter the path to your local `..\CustomTechDocs\Import\imports.mf` file in the Manifest File field.
4850
6. Select the following in the Available for Import field.
49-
* **aras.labs.CustomTechDocs**
50-
* **com.aras.innovator.solution.TechDoc**
51-
* **com.aras.innovator.tdf**
52-
* **com.aras.innovator.solution.PLM**
51+
* **aras.labs.CustomTechDocs**
52+
* **com.aras.innovator.solution.TechDoc**
53+
* **com.aras.innovator.tdf**
54+
* **com.aras.innovator.solution.PLM**
5355
7. Select Type = **Merge** and Mode = **Thorough Mode**.
5456
8. Click **Import** in the top left corner.
5557
9. Close the Aras Package Import tool.
@@ -58,6 +60,8 @@ You are now ready to login to Aras and try out the CustomTechDocs project.
5860

5961
## Usage
6062

63+
### Customized Item-Info Element
64+
6165
**Pre-requisite:** The Aras instance should include some Parts with BOM relationships.
6266

6367
1. Log in to Aras as admin.
@@ -66,6 +70,19 @@ You are now ready to login to Aras and try out the CustomTechDocs project.
6670
4. Add an ItemInfo element to the document, selecting a Part with Part BOM relationships when the search dialog appears.
6771
5. Save the document.
6872

73+
### Tech Doc Templates
74+
75+
1. Log in to Aras as admin.
76+
2. Navigate to **Technical Documentation > Technical Documents**.
77+
3. Create a new Technical Document with the `Standard` schema.
78+
4. Check off the **Is Template** field on the Tech Doc form.
79+
5. Save the document.
80+
6. Add some content to the template document.
81+
7. Save, unlock and close the document.
82+
8. In the main grid, right click the new template document and select **Create New From Template**.
83+
84+
The new document will open in a new tab. The content will be populated based on the selected template.
85+
6986
## Contributing
7087

7188
1. Fork it!

0 commit comments

Comments
 (0)