From ef1184059785f8a6b32681ce20b3364010dfcd5d Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Mon, 23 Mar 2026 10:49:28 -0700 Subject: [PATCH 1/6] Edit: Customize document templates --- .../_customize-document-templates.qmd | 57 ++++++++----------- .../guide/templates/_outline-editing-mode.qmd | 36 ++++++++++++ 2 files changed, 61 insertions(+), 32 deletions(-) create mode 100644 site/guide/templates/_outline-editing-mode.qmd diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index ab365e238f..764cf113a3 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -3,7 +3,15 @@ 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**. +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**. @@ -14,50 +22,35 @@ 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 document templates on documents will only apply changes to that document's specific 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 template. - Once saved, your new template version becomes available for use. +::: :::: diff --git a/site/guide/templates/_outline-editing-mode.qmd b/site/guide/templates/_outline-editing-mode.qmd new file mode 100644 index 0000000000..44ce22a20b --- /dev/null +++ b/site/guide/templates/_outline-editing-mode.qmd @@ -0,0 +1,36 @@ +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)] + + ::: \ No newline at end of file From a7258ffcca548ffae5857f847e495682a1461485 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Mon, 23 Mar 2026 10:51:21 -0700 Subject: [PATCH 2/6] Save point --- site/guide/templates/_customize-document-templates.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index 764cf113a3..9627890fc0 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -48,7 +48,7 @@ Editing outlines for document templates on documents will only apply changes to {{< include /guide/templates/_outline-editing-mode.qmd >}} -1. When you're done, click **Done Editing** to apply your changes to that specific document's template. +1. When you're done, click **Done Editing** to apply your changes to that specific document's active template. ::: From 1372a35b586e4902db0e9d5cacefe6b47ede2aba Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Mon, 23 Mar 2026 11:01:28 -0700 Subject: [PATCH 3/6] Save point --- .../_customize-document-templates.qmd | 37 ++++++++++++++++++- .../customize-document-templates.qmd | 8 ++-- .../templates/manage-document-templates.qmd | 9 +++++ 3 files changed, 50 insertions(+), 4 deletions(-) diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index 9627890fc0..e18b543881 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -3,6 +3,13 @@ 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"} + + +:::: {.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} @@ -34,7 +41,7 @@ Editing outlines for document templates from **{{< fa gear >}} Settings** will c #### On documents -Editing outlines for document templates on documents will only apply changes to that document's specific template: +Editing outlines for templates on documents will only apply changes to that document's active template: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. @@ -52,6 +59,34 @@ Editing outlines for document templates on documents will only apply changes to ::: +:::: + + + +:::: {.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. + +:::: + + :::: :::: {.content-hidden unless-format="revealjs"} diff --git a/site/guide/templates/customize-document-templates.qmd b/site/guide/templates/customize-document-templates.qmd index 139bbe1982..63fb6d3eb5 100644 --- a/site/guide/templates/customize-document-templates.qmd +++ b/site/guide/templates/customize-document-templates.qmd @@ -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} @@ -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. diff --git a/site/guide/templates/manage-document-templates.qmd b/site/guide/templates/manage-document-templates.qmd index 71fac87a73..d1ac946ddf 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -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.^ + +::: + +{{< include _customize-document-templates.qmd >}} + ## Swap document templates ::: {.callout title="When swapping templates, only the document structure is changed."} From c5d40dded6ad5a3c1a54c1ffb8e240fb3afc676b Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Mon, 23 Mar 2026 11:04:50 -0700 Subject: [PATCH 4/6] Edit: Manage document templates --- .../templates/manage-document-templates.qmd | 40 ++++++++++--------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/site/guide/templates/manage-document-templates.qmd b/site/guide/templates/manage-document-templates.qmd index d1ac946ddf..beb6943e56 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -32,7 +32,7 @@ View and swap between different document templates or template versions, or dupl ## Edit document template outlines ::: {.callout} -Permissions for directly editing document template outlines are defined by document type and determined by your organization's setup.^ +Permissions for directly editing document template outlines are defined by document type and determined by your organization's setup.[^3] ::: @@ -50,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] + 1. In outline editing mode, you can: ::: {.panel-tabset}