diff --git a/guide/source/conf.py b/guide/source/conf.py index ffc7953f..5051afd5 100644 --- a/guide/source/conf.py +++ b/guide/source/conf.py @@ -59,9 +59,9 @@ # built documents. # # The short X.Y version. -version = '3.1' # should match hpxml version +version = '4.0' # should match hpxml version # The full version, including alpha/beta/rc tags. -release = '3.1' +release = '4.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/guide/source/index.rst b/guide/source/index.rst index 7200b827..81688b62 100644 --- a/guide/source/index.rst +++ b/guide/source/index.rst @@ -2,7 +2,8 @@ HPXML Implementation Guide ########################## -.. todolist:: +.. warning:: + We have made efforts to update this incrementally as new versions are released, but some of the information in this guide may be out of date with the latest HPXML standard. .. only:: html diff --git a/guide/source/overview.rst b/guide/source/overview.rst index 13885f98..6cd0d33c 100644 --- a/guide/source/overview.rst +++ b/guide/source/overview.rst @@ -60,7 +60,7 @@ The HPXML Working Group can be a valuable resource for program administrators, i Versioning ========== -The HPXML schema follows the `Semantic Versioning 2.0 specification `_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 3.1.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations. +The HPXML schema follows the `Semantic Versioning 2.0 specification `_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 4.0.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations. The minor version number is incremented when the schemas are changed in a manner that is backwards compatible with previous versions that share the same major version. In other words, a document created in a previous version of the schema will also validate against the new schema. Examples of changes that require a minor version change include adding elements, adding enumerations, and changing the annotation in the schema for an element. diff --git a/guide/source/program_administrator/identify_data_needs.rst b/guide/source/program_administrator/identify_data_needs.rst index 3406b86a..d1c8ec11 100644 --- a/guide/source/program_administrator/identify_data_needs.rst +++ b/guide/source/program_administrator/identify_data_needs.rst @@ -54,19 +54,15 @@ Adopting these best practices will assist in establishing a streamlined data sel HPXML Data Selection Tool ************************* -To assist program administrators in reviewing the standard datasets that are being implemented by other programs, a data selection tool is available to help identify the required data points. The tool also helps programs select and communicate the requirements for the program to contractors, trade allies, and other stakeholders. The HPXML Data Selection Tool is a "living document" so if a program identifies data points that are not in the datasets, the HPXML working group can assist in adding them to the tool to meet the program’s needs. +.. warning:: - * Download: :download:`HPXML Data Selection Tool ` - -The attached instructional video provides a walkthrough of the HPXML data selection tool. By using the tool, programs can quickly select the data required for HPXML program implementation. Programs can then forward the tool to the implementation team, trade allies and software providers, giving them clear guidance on the requirements for HPXML Implementation with your program. + The data selection tool spreadsheet no longer represents the latest HPXML version. Some of information may still be relevant, so it is here for reference for those interested. -.. raw:: html +To assist program administrators in reviewing the standard datasets that are being implemented by other programs, a data selection tool is available to help identify the required data points. The tool also helps programs select and communicate the requirements for the program to contractors, trade allies, and other stakeholders. The HPXML Data Selection Tool is a "living document" so if a program identifies data points that are not in the datasets, the HPXML working group can assist in adding them to the tool to meet the program's needs. - - -.. raw:: latex + * Download: :download:`HPXML Data Selection Tool ` - \par\href{https://youtu.be/vmfU1ytzMfc}{YouTube: HPXML Data Selection Tool Tutorial}\par +By using the tool, programs can quickly select the data required for HPXML program implementation. Programs can then forward the tool to the implementation team, trade allies and software providers, giving them clear guidance on the requirements for HPXML Implementation with your program. Additional details about the data structure and standard datasets are provided in the sections below. diff --git a/guide/source/software_developer/versioning.rst b/guide/source/software_developer/versioning.rst index 0c6ddabb..757e915f 100644 --- a/guide/source/software_developer/versioning.rst +++ b/guide/source/software_developer/versioning.rst @@ -3,7 +3,7 @@ Versioning The HPXML schemas follow the `Semantic Versioning v2.0 `_ specification. The version numbers follow a pattern of :ref:`major-version`. -:ref:`minor-version`. :ref:`patch-version` (i.e. 3.1.0). +:ref:`minor-version`. :ref:`patch-version` (i.e. 4.0.0). The first element of ``HPXML.xsd`` will indicate the version of the schema via the ``version`` attribute. Note that when referencing a version, the patch @@ -12,7 +12,7 @@ number is assumed to be zero if it is omitted. .. code-block:: xml + targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.0"> Additionally, starting with version 2.0, the version of the schema used is required in the ``schemaVersion`` attribute on the root element of every @@ -20,7 +20,7 @@ document. .. code-block:: xml - + .. _major-version: diff --git a/guide/source/tools_and_resources.rst b/guide/source/tools_and_resources.rst index 6f4fdbe2..ab407a7c 100644 --- a/guide/source/tools_and_resources.rst +++ b/guide/source/tools_and_resources.rst @@ -6,12 +6,12 @@ A number of tool and resources exist to help software developers, programs, and HPXML Website ************* -The Home Performance Coalition hosts a website that has information, tools, and resources on HPXML and its business cases. The website is: https://www.hpxmlonline.com. +The Building Performance Association hosts a website that has information, tools, and resources on HPXML and its business cases. The website is: https://www.hpxmlonline.com. HPXML Implementation Guide ************************** -The `HPXML Implementation Guide `_ provides detailed information to programs and software developers on how to implement HPXML. +The `HPXML Implementation Guide `_ (this document) provides detailed information to programs and software developers on how to implement HPXML. HPXML Data Selection Tool ************************* @@ -28,7 +28,7 @@ There is also a data dictionary for HPXML included in the Toolbox that documents HEScore Translator ****************** -The Home Energy Score Translator generates HEScore inputs from HPXML files. The translator is incorporated into the HEScore API. By using this translator, software developers can leverage their investment in HPXML to provide HESCORE functionality with minimum development cost. +The Home Energy Score Translator generates HEScore inputs from HPXML files. The translator is `incorporated into the HEScore API `_. By using this translator, software developers can leverage their investment in HPXML to provide HEScore functionality with minimum development cost. Home Upgrade Program Accelerator ********************************