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
92 changes: 60 additions & 32 deletions site/guide/templates/_customize-document-templates.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,22 @@ 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"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.
<!-- VISIBLE ONLY ON PAGES THAT HAVE A CUSTOM METADATA TAG:

```includes:
custommize: true
``` -->

:::: {.content-visible when-format="html" when-meta="includes.customize"}
Edit outlines for document templates from **{{< fa gear >}} Settings** or directly on model documents:

::: {.panel-tabset}

#### From **{{< fa gear >}} Settings**

Editing outlines for document templates from **{{< fa gear >}} Settings** will create a new version of the template that can be applied to model documents:

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

1. Under Documents, select **Templates**.

Expand All @@ -14,50 +29,63 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
- **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)]
- **Custom**^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)]

1. Click the template to edit and on the template details page, select **{{< fa pencil >}} Edit Outline**.
1. Click the template to edit and on the template details page, select **{{< fa pencil >}} Edit Outline**.

1. In outline editing mode, you can:
{{< include /guide/templates/_outline-editing-mode.qmd >}}

::: {.panel-tabset}
1. When you're done, click **Create New Version** to view a side-by-side comparison of your changes with the previous version:
- Add a description in **[version notes]{.smallcaps}** to track your changes.
- Click **Save** to save the new version.

#### Work with existing sections
Once saved, your new template version becomes available for use.

Expand sections
: Expand the menu for any sections with subsections by clicking **{{< fa chevron-down >}}**.
#### On documents

Rename sections
: 1. Hover over a section until the **{{< fa pencil >}}** appears, then click on it to change the name.
1. Save by clicking **{{< fa check >}}**.
Editing outlines for templates on documents will only apply changes to that document's active template:

Remove sections
: 1. Hover over the section you want to delete.
1. When the **{{< fa trash-can >}}** appears, click on it.
1. After you confirm, that section will be removed.
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

Reorder sections
: Click **{{< fa ellipsis-vertical >}}{{< fa ellipsis-vertical >}}** and hold firmly to drag to reorder sections.
1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]

#### Add new sections and content
1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)]

Insert new sections
: Click **{{< fa plus >}}** to add a new section or subsection to the template:
- To add a section above the current section, select **{{< fa arrow-up >}} Section Before**.
- To add a section below the current section, select **{{< fa arrow-down >}} Section After**.
- To add a subsection within the current section, select **{{< fa arrow-right >}} Subsection**.
1. Click on the document you would like to customize the template outline for.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)]

Add content to sections
: In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional [content]{.smallcaps}:
- **{{< fa align-justify >}} Summary Block** [validation reports only]{.smallercaps .pink}
- **{{< fa circle-check >}} Guideline Block**^[[Add guidelines to templates](/guide/model-validation/manage-validation-guidelines.qmd#add-guidelines-to-templates)] [validation reports only]{.smallercaps .pink}
- **{{< fa align-left >}} Text Block**^[[Add text blocks via template outlines](/guide/templates/customize-document-templates.qmd#add-text-blocks-via-template-outlines)]
1. On the template details page, click **{{< fa pencil >}} Edit Outline**.

:::
{{< include /guide/templates/_outline-editing-mode.qmd >}}

1. When you're done, click **Create New Version** to view a side-by-side comparison of your changes with the previous version:
- Add a description in **[version notes]{.smallcaps}** to track your changes.
- Click **Save** to save the new version.
1. When you're done, click **Done Editing** to apply your changes to that specific document's active template.

:::

::::

<!-- VISIBLE ONLY ON PAGES THAT **DO NOT** HAVE A CUSTOM METADATA TAG:

```includes:
customize: true
``` -->

:::: {.content-visible when-format="html" unless-meta="includes.customize"}
Edit outlines for templates directly on documents to only apply changes to that document's active template:

1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]

1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)]

1. Click on the document you would like to customize the template outline for.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)]

1. On the template details page, click **{{< fa pencil >}} Edit Outline**.

{{< include /guide/templates/_outline-editing-mode.qmd >}}

1. When you're done, click **Done Editing** to apply your changes to that specific document's active template.

::::

Once saved, your new template version becomes available for use.

::::

Expand Down
40 changes: 40 additions & 0 deletions site/guide/templates/_outline-editing-mode.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!-- 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 -->

1. In outline editing mode, you can:

::: {.panel-tabset}

#### Work with existing sections

Expand sections
: Expand the menu for any sections with subsections by clicking **{{< fa chevron-down >}}**.

Rename sections
: 1. Hover over a section until the **{{< fa pencil >}}** appears, then click on it to change the name.
1. Save by clicking **{{< fa check >}}**.

Remove sections
: 1. Hover over the section you want to delete.
1. When the **{{< fa trash-can >}}** appears, click on it.
1. After you confirm, that section will be removed.

Reorder sections
: Click **{{< fa ellipsis-vertical >}}{{< fa ellipsis-vertical >}}** and hold firmly to drag to reorder sections.

#### Add new sections and content

Insert new sections
: Click **{{< fa plus >}}** to add a new section or subsection to the template:
- To add a section above the current section, select **{{< fa arrow-up >}} Section Before**.
- To add a section below the current section, select **{{< fa arrow-down >}} Section After**.
- To add a subsection within the current section, select **{{< fa arrow-right >}} Subsection**.

Add content to sections
: In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional [content]{.smallcaps}:
- **{{< fa align-justify >}} Summary Block** [validation reports only]{.smallercaps .pink}
- **{{< fa circle-check >}} Guideline Block**^[[Add guidelines to templates](/guide/model-validation/manage-validation-guidelines.qmd#add-guidelines-to-templates)] [validation reports only]{.smallercaps .pink}
- **{{< fa align-left >}} Text Block**^[[Add text blocks via template outlines](/guide/templates/customize-document-templates.qmd#add-text-blocks-via-template-outlines)]

:::
8 changes: 5 additions & 3 deletions site/guide/templates/customize-document-templates.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ aliases:
- /guide/customize-documentation-templates.html
- /guide/model-documentation/customize-documentation-templates.html
- /guide/templates/customize-documentation-templates.html
includes:
customize: true
---

Customize templates for document types to fit your specific case-by-case needs, such as type or complexity of model or model use case.

- Templates are versioned and saving a template after making changes or reverting to a previous version state always creates a new version, or you can duplicate templates to create new independent templates in your library.
- Document templates are stored as YAML files edited directly using the advanced editor, allowing you full control over the minitua such as desired guidelines.
- Templates are versioned and saving a template after making changes or reverting to a previous version state always creates a new version, or you can duplicate templates to create new independent templates in your library.
- Document templates are stored as YAML files edited directly using the advanced editor, allowing you full control over the minitua such as desired guidelines.
- We also provide a simplified editing experience to allow you to easily construct and rearrange the outline of your template.

::: {.attn}
Expand All @@ -22,7 +24,7 @@ Customize templates for document types to fit your specific case-by-case needs,

- [x] {{< var link.login >}}
- [x] The template you want to edit must exist in the {{< var validmind.platform >}}.[^1]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]

::: {.callout title="Not sure which template or which version of a template your document is using?"}
Check the [document template]{.smallcaps} section[^3] in the right sidebar.
Expand Down
47 changes: 29 additions & 18 deletions site/guide/templates/manage-document-templates.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ View and swap between different document templates or template versions, or dupl

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

## Edit document template outlines

::: {.callout}
Permissions for directly editing document template outlines are defined by document type and determined by your organization's setup.[^3]

:::

{{< include _customize-document-templates.qmd >}}

## Swap document templates

::: {.callout title="When swapping templates, only the document structure is changed."}
Expand All @@ -41,14 +50,14 @@ Switch a document to a completely different template, or apply another version o

1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

2. Select a model or find your model by applying a filter or searching for it.[^3]
2. Select a model or find your model by applying a filter or searching for it.[^4]

3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^4]
3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5]

4. Select the document you want to view the template for:

- 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.[^5]
- 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.**
Expand Down Expand Up @@ -92,7 +101,7 @@ d. Click **Apply Changes to Template** to complete the swap.

::: {.callout-important title="Template deletion is permanent and cannot be undone."}

- Deleting a template deletes all versions of that template.[^6]
- Deleting a template deletes all versions of that template.[^7]
- Templates can only be deleted if they are not in use by any documents.
:::

Expand All @@ -104,14 +113,14 @@ Delete templates no longer required by your organization:

3. Select one of the tabs for the document type with the templates you want to remove:

- **Development**[^7]
- **Validation**[^8]
- **Monitoring**[^9]
- **Custom**[^10]
- **Development**[^8]
- **Validation**[^9]
- **Monitoring**[^10]
- **Custom**[^11]

4. Select the template you would like to delete by clicking on it.

Review the details of the template to confirm the template is no longer required.[^11]
Review the details of the template to confirm the template is no longer required.[^12]

5. Click **Delete Template** to remove that template.

Expand All @@ -124,11 +133,13 @@ Delete templates no longer required by your organization:

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

[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
[^3]: [Manage document types](/guide/templates/manage-document-types.qmd)

[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)

[^4]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)
[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)

[^5]:
[^6]:

- **[title]{.smallcaps}** — Sort by title alphabetically.
- **[type]{.smallcaps}** — Sort by document type alphabetically.
Expand All @@ -139,17 +150,17 @@ Delete templates no longer required by your organization:

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.

[^6]: [Customize document templates](customize-document-templates.qmd#edit-template-outlines)
[^7]: [Customize document templates](customize-document-templates.qmd#edit-template-outlines)

[^7]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)
[^8]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)

[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)
[^9]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)

[^9]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)
[^10]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

[^10]: [Working with model documents](/guide/templates/working-with-model-documents.qmd)
[^11]: [Working with model documents](/guide/templates/working-with-model-documents.qmd)

[^11]:
[^12]:

[View document templates](#view-document-templates)<br></br>

Expand Down
18 changes: 12 additions & 6 deletions site/guide/templates/manage-document-types.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,15 @@ These stock document types cannot be deleted, only edited:

- Provide a **[name]{.smallcaps}** and an optional **[description]{.smallcaps}**.
- Toggle whether this document type should be automatically created **[when model is registered]{.smallcaps}**.
- Select the model stakeholder types[^2] that should have **[write permissions]{.smallcaps}** for this document type.
- Toggle an optional **[default template]{.smallcaps}** for this document type.[^3]
- Toggle an optional **[default template]{.smallcaps}** for this document type.[^2]
- Select the model stakeholder types[^3] that should have **[update document]{.smallcaps}** permissions for this document type.[^4]
- Select the model stakeholder types that should have **[update document outline]{.smallcaps}** permissions for this document type.[^5]


5. Click **Create Document Type** to add your document type.

::: {.callout}
Once created, customize the available templates for your document type.[^4]
Once created, customize the available templates for your document type.[^6]

:::

Expand Down Expand Up @@ -87,11 +89,15 @@ In order to delete a document type, there must be no models using that document

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

[^2]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd)
[^2]: Select a template to be assigned as default from the drop-down menu.

[^3]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd)

[^4]: [Manage model documents](manage-model-documents.qmd#edit-model-documents)

[^3]: Select a template to be assigned as default from the drop-down menu.
[^5]: [Manage document templates](/guide/templates/manage-document-templates.qmd#edit-document-template-outlines)

[^4]: [Customize document templates](customize-document-templates.qmd)
[^6]: [Customize document templates](customize-document-templates.qmd)



Expand Down
Loading