Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions site/faq/faq-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^6] has sufficien
Yes, you can reuse content from existing documents or templates:

- Build a library of reusable text blocks to insert into your documents, including content from existing documents.[^13]
- Duplicate document templates to create new templates with the same content, then edit those duplicates to fit your needs.[^14]
- Create blank document templates for a document type, or generate a structure-only outline from a PDF with selectable text.[^14]
- Duplicate document templates to create new templates with the same content, then edit those duplicates to fit your needs.[^16]

## Can documents be created right in the {{< var validmind.platform >}}?

Expand Down Expand Up @@ -130,6 +131,8 @@ Yes, {{< var vm.product >}} allows you to leverage content from historical or ex

[^13]: [Manage text block library](/guide/templates/manage-text-block-library.qmd)

[^14]: [Manage document templates](/guide/templates/manage-document-templates.qmd)
[^14]: [Manage document templates — Create document templates](/guide/templates/manage-document-templates.qmd#create-document-templates)

[^15]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents)

[^16]: [Manage document templates — Duplicate document templates](/guide/templates/manage-document-templates.qmd#duplicate-document-templates)
67 changes: 67 additions & 0 deletions site/guide/templates/_create-document-templates.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!-- Copyright © 2023-2026 ValidMind Inc. All rights reserved.
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

:::: {.content-visible unless-format="revealjs"}
Create a new blank template for a document type, then build the outline manually or generate it from a PDF:

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under {{< fa file >}} Documents, select **Templates**.

3. Select the tab for the document type you want the template to belong to:

- **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)]
- **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)]
- **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)]
- **Custom**^[[Managing documents](/guide/templates/managing-documents.qmd)]

4. Click **{{< fa plus >}} Create [Document Type] Template** (for example **Create Development Template**).

5. In the **Create Template** modal, enter a unique **Template Name** and a **Description**, then click **Create Template**.

The new template opens with an empty outline. To use it on inventory documents, associate it with a document type.^[[Manage document types](/guide/templates/manage-document-types.qmd)]

6. Choose how to start the outline:

::: {.panel-tabset}

### Build Outline Manually

a. Select **Build Outline Manually**.

b. Use the outline editor to add sections and content blocks.^[[Customize document templates](/guide/templates/customize-document-templates.qmd#edit-template-outlines)]

### Start Outline From PDF

a. Select **Start Outline From PDF**.

b. Upload a **.pdf** file (drag and drop or choose a file), then click **Upload PDF**.

::: {.callout-note}
## PDF requirements and limits

- PDFs must contain selectable text and headings. Scanned or image-only PDFs cannot generate an outline.
- Maximum size: **20 MB**. Maximum length: **100 pages**.
- Parsing creates a **structure-only** outline (sections and subsections with empty text placeholders). Charts and other graphics are not converted into test or metric blocks.
:::

c. Track progress in **My Inbox**. When processing finishes, the outline is saved to the template (as a new version when applied).

You can also choose **Generate from PDF** later from the template outline actions when you want to regenerate structure from a PDF.

:::

::::


:::: {.content-hidden unless-format="revealjs"}
Create a new blank template for a document type, then build the outline manually or generate it from a PDF:

1. In the left sidebar, click **{{< fa gear >}} Settings**.
2. Under {{< fa file >}} Documents, select **Templates**.
3. Select the tab for the [document type](/guide/templates/managing-documents.qmd){target="_blank"} you want the template to belong to.
4. Click **{{< fa plus >}} Create [Document Type] Template**, enter a unique **Template Name** and **Description**, then click **Create Template**.
5. On the blank outline, choose **Build Outline Manually** or **Start Outline From PDF** (selectable-text PDFs only; structure-only outline; track progress in **My Inbox**).

::::
42 changes: 29 additions & 13 deletions site/guide/templates/_duplicate-template.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,38 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-visible unless-format="revealjs"}
To duplicate an existing template and start with version one of that new template:

1. In the left sidebar, click **{{< fa gear >}} Settings**.
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under {{< fa file >}} Documents, select **Templates**.
2. Under {{< fa file >}} Documents, select **Templates**.

1. Select one of the tabs for the type of template you want to duplicate:
3. Select one of the tabs for the type of template you want to duplicate:

- **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)]
- **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)]
- **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)]
- **Custom**^[[Managing documents](/guide/templates/managing-documents.qmd)]

1. Click on the template to duplicate and on the template details page, select **{{< fa copy >}} Duplicate Template**.
4. Duplicate the template from the list or from template details:

1. In the Duplicate Template modal that opens, give your copy a **Template Name** and a **Template Description**.
::: {.panel-tabset}

1. Click **Duplicate Template** to create a copy of your template.
### From the templates list

a. Hover over the template until the **{{< fa ellipsis-vertical >}}** menu appears under **Actions**, then click on it.

b. Select **{{< fa copy >}} Duplicate**.

### From template details

a. Click the template to open it.

b. Select **{{< fa copy >}} Duplicate Template**.

:::

5. In the Duplicate Template modal that opens, give your copy a **Template Name** and a **Template Description**.

6. Click **Duplicate Template** to create a copy of your template.

Once duplicated, customize your new template to your needs, making it available for use with your documents.

Expand All @@ -30,18 +46,18 @@ Once duplicated, customize your new template to your needs, making it available
:::: {.content-hidden unless-format="revealjs"}
To duplicate an existing template and start with version one of that new template:

1. In the left sidebar, click **{{< fa gear >}} Settings**.
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under {{< fa file >}} Documents, select **Templates**.
2. Under {{< fa file >}} Documents, select **Templates**.

1. Select one of the tabs for the [type of template you want to duplicate](/guide/templates/managing-documents.qmd){target="_blank"}.
3. Select one of the tabs for the [type of template you want to duplicate](/guide/templates/managing-documents.qmd){target="_blank"}.

1. Click on the template to duplicate and on the template details page, select **{{< fa copy >}} Duplicate Template**.
4. From the list **{{< fa ellipsis-vertical >}}** menu, select **{{< fa copy >}} Duplicate**, or open the template and select **{{< fa copy >}} Duplicate Template**.

1. In the Duplicate Template modal that opens, give your copy a **Template Name** and a **Template Description**.
5. In the Duplicate Template modal that opens, give your copy a **Template Name** and a **Template Description**.

1. Click **Duplicate Template** to create a copy of your template.
6. Click **Duplicate Template** to create a copy of your template.

Once duplicated, customize your new template to your needs, making it available for use with your documents.

::::
::::
24 changes: 11 additions & 13 deletions site/guide/templates/manage-document-templates.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,27 @@ aliases:
- /guide/templates/view-documentation-templates.html
---

View and swap between different document templates or template versions, or duplicate and delete templates.
Create blank document templates or generate outlines from PDFs, then view, swap, duplicate, and delete templates for your organization.

::: {.attn}

## Prerequisites

- [x] {{< var link.login >}}
- [x] To swap between templates or template versions, more than one template or version must exist for that document type.[^1]
- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] To **create** or **delete** templates, you are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with the **Create Template** or **Delete Template** permission.[^1]
- [x] To swap between templates or template versions, more than one template or version must exist for that document type.[^2]
- [x] To swap templates on a record document, you are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions.[^1]

:::

## View document templates

{{< include /guide/templates/_view-document-templates.qmd >}}

## Create document templates {#create-document-templates}

{{< include /guide/templates/_create-document-templates.qmd >}}

## Edit document template outlines

::: {.callout}
Expand Down Expand Up @@ -59,13 +64,6 @@ Switch a document to a completely different template, or apply another version o
- Click **{{< fa magnifying-glass >}} Search** to search for documents by keywords in the document title.
- Click **{{< fa arrow-up-wide-short >}} Sort** to reorder the list using different criteria in ascending or descending order.[^6]

<!-- ::: {.column-margin}
**Note that searching and sorting of fields stack.**

For example, if you first search by keyword for `ValidMind` without clearing that search, any additional sorting applied will only apply to the results returned by that initial search.

::: -->

5. On your document's detail page, locate **Document Template**.

6. View the currently applied template and version, or swap to another template or version:
Expand Down Expand Up @@ -129,9 +127,9 @@ Delete templates no longer required by your organization:

<!-- FOOTNOTES -->

[^1]: [Manage document types](manage-document-types.qmd)
[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
[^2]: [Manage document types](manage-document-types.qmd)

[^3]: [Manage document types](/guide/templates/manage-document-types.qmd)

Expand Down Expand Up @@ -167,4 +165,4 @@ Delete templates no longer required by your organization:
**To delete a template without reviewing template details:**<br></br>

a. Hover over the template until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it.
b. Select [**{{< fa trash-can >}} Delete**]{.red}.
b. Select [**{{< fa trash-can >}} Delete**]{.red}.
Loading
Loading