Skip to content

Commit f91aaca

Browse files
committed
Deployed 112fbea with MkDocs version: 1.6.1
1 parent 399e237 commit f91aaca

File tree

10 files changed

+38
-57
lines changed

10 files changed

+38
-57
lines changed

dev-guide/creating-a-report-module/index.html

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4127,13 +4127,14 @@ <h3 id="json-configuration-structure">JSON Configuration Structure</h3>
41274127
<h3 id="language-configuration">Language Configuration</h3>
41284128
<div class="admonition info">
41294129
<p class="admonition-title">Info</p>
4130-
<p>Language support is <strong>coming soon</strong>! This feature is currently in development and will be included in AsBuiltReport.Core v1.5.0.</p>
4130+
<p>AsBuiltReport.Core v1.5.0+ provides the translation functionality for both core UI prompts and report module content.</p>
4131+
<p>Individual report modules provide their own translation files for report-specific content such as headings, text, and tables.</p>
4132+
<p>Please refer to individual <a href="https://www.asbuiltreport.com/user-guide/report-modules/overview/">report module documentation</a> for their language support.</p>
41314133
</div>
41324134
<p>The <code>Language</code> property in the <code>Report</code> section specifies the default language for report content. This setting can be overridden at runtime using the <a href="../../user-guide/new-asbuiltreport/">New-AsBuiltReport</a> <code>-ReportLanguage</code> parameter when generating reports.</p>
41334135
<p><strong>Language Support Requirements:</strong></p>
41344136
<ul>
41354137
<li><strong>Minimum requirement:</strong> All report modules must provide <code>en-US</code> (English - United States) language support</li>
4136-
<li><strong>Recommended:</strong> Report modules should aim to support as many languages as possible from the available languages list</li>
41374138
<li><strong>Optional:</strong> Additional languages can be provided based on contributor availability and community needs</li>
41384139
</ul>
41394140
<h4 id="languages-supported-by-asbuiltreportcore">Languages supported by AsBuiltReport.Core</h4>
@@ -4530,10 +4531,6 @@ <h3 id="private-helper-functions">Private Helper Functions</h3>
45304531
<li>Implement proper error handling</li>
45314532
</ul>
45324533
<h2 id="language-support-implementation">Language Support Implementation</h2>
4533-
<div class="admonition info">
4534-
<p class="admonition-title">Info</p>
4535-
<p>Language support is <strong>coming soon</strong>! This feature is currently in development and will be included in AsBuiltReport.Core v1.5.0.</p>
4536-
</div>
45374534
<p>AsBuiltReport v1.5.0+ introduces comprehensive multilingual support, allowing report modules to generate documentation in multiple languages. This section explains how to implement language support in your report module.</p>
45384535
<h3 id="overview">Overview</h3>
45394536
<p>The language support system consists of two components:</p>
@@ -5445,7 +5442,7 @@ <h3 id="getting-help">Getting Help</h3>
54455442
<span class="md-icon" title="Last update">
54465443
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
54475444
</span>
5448-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 13, 2025</span>
5445+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 21, 2025</span>
54495446
</span>
54505447

54515448

dev-guide/creating-a-report-style/index.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2719,10 +2719,6 @@ <h1>Creating a report style</h1>
27192719
<p>Use the <a href="https://github.com/AsBuiltReport/AsBuiltReport.Core/blob/master/AsBuiltReport.Core.Style.ps1" target="_blank">default style script</a> as a reference for creating a new style script.</p>
27202720
</div>
27212721
<h3 id="language-support">Language Support</h3>
2722-
<div class="admonition info">
2723-
<p class="admonition-title">Info</p>
2724-
<p>Language support is <strong>coming soon</strong>! This feature is currently in development and will be included in AsBuiltReport.Core v1.5.0.</p>
2725-
</div>
27262722
<p>To support report language translations in AsBuiltReport v1.5.0 or higher, ensure the following code is added to the top of your style scripts.</p>
27272723
<div class="highlight"><span class="filename">PowerShell</span><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">try</span> <span class="p">{</span>
27282724
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="c"># Try to initialize localized data for style elements</span>
@@ -2997,7 +2993,7 @@ <h4 id="cover-page">Cover Page</h4>
29972993
<span class="md-icon" title="Last update">
29982994
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
29992995
</span>
3000-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2025</span>
2996+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 21, 2025</span>
30012997
</span>
30022998

30032999

feed_json_updated.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"version": "https://jsonfeed.org/version/1", "title": "AsBuiltReport", "home_page_url": "https://www.asbuiltreport.com/", "feed_url": "https://www.asbuiltreport.com/feed_json_updated.json", "description": "Document Your Datacenter With PowerShell", "icon": null, "authors": [{"name": "Tim Carman"}], "language": "en", "items": [{"id": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "url": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "title": "The history of AsBuiltReport", "content_html": "<h1>The history of AsBuiltReport</h1>\n<h2>The Beginning</h2>\n<p>Back in 2017, having worked on designing and implementing VMware solutions for almost a decade, I became frustrated with having to repeatedly produce as-built documentation for my virtualisation projects.</p>\n<p>At the time, I was designing and implementing 2-3 VMware solutions per month. Each solution would be designed using numerous technology partners, each with their own range of compute, storage, networking and backup technologies.</p>\n<p>My methods to create as-built documentation was arduous, time consuming and error prone. It often involved extracting information using a combination of vendor supplied tools and community developed scripts, and manually transposing information from the vCenter console into a Word document. It was tedious and often resulted in a poorly constructed and formatted document.</p>\n<p>It was also around this time that I realised I had a strong desire to learn PowerShell after seeing many of my co-workers starting to write scripts to automate simple, repeatable tasks. Until this moment, I had never taken the time to completely understand the fundamentals of PowerShell, nor had I worked to develop and expand my knowledge in any form of scripting or automation.</p>\n<p>As a result, I saw this as an opportunity to learn and employ PowerShell automation to ease my pain and frustrations with producing as-built documentation. And so began my mission to create AsBuiltReport!</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\2023\\08\\25\\the-history-of-asbuiltreport.png", "date_modified": "2025-10-20T23:45:19.667101+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "url": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "title": "The future of AsBuiltReport", "content_html": "<h1>The future of AsBuiltReport</h1>\n<p>In my <a href=\"../posts/The-history-of-As-Built-Report.md\">previous post</a> I shared how I came to start AsBuiltReport and my reasons for doing so. It's been a few years since its inception and some of you may be asking what does the future hold for the project?</p>\n<p>Before I delve into what may lie ahead, let me take a moment to reflect on the project's progression so far, by extending a sincere thank you to all the <a href=\"../../about/contributors.md\">contributors</a> who have given their time and effort to this project. Whether you have contributed code, reported bugs, provided feedback, written a blog post, or simply participated in discussions, your efforts have not gone unnoticed.</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\2023\\12\\05\\The-future-of-As-Built-Report.png", "date_modified": "2025-10-20T23:45:19.584491+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "url": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "title": "Multilingual support is coming soon to AsBuiltReport", "content_html": "<h1>Multilingual support is coming soon to AsBuiltReport</h1>\n<p>Today I can announce that one of the most requested features for AsBuiltReport is currently in pre-release, with testing underway to bring <strong>multilingual support</strong> to the AsBuiltReport framework.</p>\n<p><img alt=\"multilingual\" src=\"../../assets/images/blog/multilingual.jpg\">{ loading=lazy }</p>\n<h2>Key Features in Development</h2>\n<p><strong>\ud83c\udf10 Comprehensive Localization Framework</strong></p>\n<ul>\n<li>\n<p>Implementation of PowerShell's built-in localization capabilities</p>\n</li>\n<li>\n<p>Option for differing UI localization and report localization</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcdd Standardised Translation Structure</strong></p>\n<ul>\n<li>\n<p>Standardised folder structures for simple multilingual support adoption</p>\n</li>\n<li>\n<p>Support for resource files containing translated strings for AsBuiltReport core and report modules</p>\n</li>\n<li>\n<p>Automated string extraction and translation</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcbb New Commandline Parameters</strong></p>\n<ul>\n<li>\n<p>Dynamic language selection - language selection is determined by what each AsBuiltReport module supports</p>\n</li>\n<li>\n<p>Support for standard locale codes (en-US, es-ES, fr-FR, de-DE, etc.)</p>\n</li>\n<li>\n<p>Fallback mechanism to ensure reports generate even with incomplete translations</p>\n</li>\n</ul>\n<p><strong>:gear: Report Module Integration</strong></p>\n<ul>\n<li>\n<p>Documentation and templates for new and existing report modules to add multilingual support</p>\n</li>\n<li>\n<p>Backward compatibility ensuring existing English-only workflows continue to work</p>\n</li>\n<li>\n<p>Progressive enhancement allowing modules to adopt localization incrementally</p>\n</li>\n</ul>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\2025\\09\\05\\Multilingual-support.png", "date_modified": "2025-10-20T23:45:19.478279+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["Announcements", "Features"]}]}
1+
{"version": "https://jsonfeed.org/version/1", "title": "AsBuiltReport", "home_page_url": "https://www.asbuiltreport.com/", "feed_url": "https://www.asbuiltreport.com/feed_json_updated.json", "description": "Document Your Datacenter With PowerShell", "icon": null, "authors": [{"name": "Tim Carman"}], "language": "en", "items": [{"id": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "url": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "title": "The history of AsBuiltReport", "content_html": "<h1>The history of AsBuiltReport</h1>\n<h2>The Beginning</h2>\n<p>Back in 2017, having worked on designing and implementing VMware solutions for almost a decade, I became frustrated with having to repeatedly produce as-built documentation for my virtualisation projects.</p>\n<p>At the time, I was designing and implementing 2-3 VMware solutions per month. Each solution would be designed using numerous technology partners, each with their own range of compute, storage, networking and backup technologies.</p>\n<p>My methods to create as-built documentation was arduous, time consuming and error prone. It often involved extracting information using a combination of vendor supplied tools and community developed scripts, and manually transposing information from the vCenter console into a Word document. It was tedious and often resulted in a poorly constructed and formatted document.</p>\n<p>It was also around this time that I realised I had a strong desire to learn PowerShell after seeing many of my co-workers starting to write scripts to automate simple, repeatable tasks. Until this moment, I had never taken the time to completely understand the fundamentals of PowerShell, nor had I worked to develop and expand my knowledge in any form of scripting or automation.</p>\n<p>As a result, I saw this as an opportunity to learn and employ PowerShell automation to ease my pain and frustrations with producing as-built documentation. And so began my mission to create AsBuiltReport!</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\2023\\08\\25\\the-history-of-asbuiltreport.png", "date_modified": "2025-10-21T00:24:39.604162+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "url": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "title": "The future of AsBuiltReport", "content_html": "<h1>The future of AsBuiltReport</h1>\n<p>In my <a href=\"../posts/The-history-of-As-Built-Report.md\">previous post</a> I shared how I came to start AsBuiltReport and my reasons for doing so. It's been a few years since its inception and some of you may be asking what does the future hold for the project?</p>\n<p>Before I delve into what may lie ahead, let me take a moment to reflect on the project's progression so far, by extending a sincere thank you to all the <a href=\"../../about/contributors.md\">contributors</a> who have given their time and effort to this project. Whether you have contributed code, reported bugs, provided feedback, written a blog post, or simply participated in discussions, your efforts have not gone unnoticed.</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\2023\\12\\05\\The-future-of-As-Built-Report.png", "date_modified": "2025-10-21T00:24:39.514603+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "url": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "title": "Multilingual support is coming soon to AsBuiltReport", "content_html": "<h1>Multilingual support is coming soon to AsBuiltReport</h1>\n<p>Today I can announce that one of the most requested features for AsBuiltReport is currently in pre-release, with testing underway to bring <strong>multilingual support</strong> to the AsBuiltReport framework.</p>\n<p><img alt=\"multilingual\" src=\"../../assets/images/blog/multilingual.jpg\">{ loading=lazy }</p>\n<h2>Key Features in Development</h2>\n<p><strong>\ud83c\udf10 Comprehensive Localization Framework</strong></p>\n<ul>\n<li>\n<p>Implementation of PowerShell's built-in localization capabilities</p>\n</li>\n<li>\n<p>Option for differing UI localization and report localization</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcdd Standardised Translation Structure</strong></p>\n<ul>\n<li>\n<p>Standardised folder structures for simple multilingual support adoption</p>\n</li>\n<li>\n<p>Support for resource files containing translated strings for AsBuiltReport core and report modules</p>\n</li>\n<li>\n<p>Automated string extraction and translation</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcbb New Commandline Parameters</strong></p>\n<ul>\n<li>\n<p>Dynamic language selection - language selection is determined by what each AsBuiltReport module supports</p>\n</li>\n<li>\n<p>Support for standard locale codes (en-US, es-ES, fr-FR, de-DE, etc.)</p>\n</li>\n<li>\n<p>Fallback mechanism to ensure reports generate even with incomplete translations</p>\n</li>\n</ul>\n<p><strong>:gear: Report Module Integration</strong></p>\n<ul>\n<li>\n<p>Documentation and templates for new and existing report modules to add multilingual support</p>\n</li>\n<li>\n<p>Backward compatibility ensuring existing English-only workflows continue to work</p>\n</li>\n<li>\n<p>Progressive enhancement allowing modules to adopt localization incrementally</p>\n</li>\n</ul>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\2025\\09\\05\\Multilingual-support.png", "date_modified": "2025-10-21T00:24:39.404791+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["Announcements", "Features"]}]}

0 commit comments

Comments
 (0)