Update render and validation reference implementation for 2023 FERC e…

…Forms - Rendering template and validation ruleset source and compiled .zip files - Sample XBRL and HTML eForms - Blank HTML eForms - Updated fercRulesetMap.json for validations - FERC-zips with content listed above by form type plus corresponding eForm 2023 taxonomy
xbrlus · Sep 15, 2023 · 915cb55 · 915cb55
1 parent 8ea60c9
commit 915cb55
Show file tree

Hide file tree

Showing 782 changed files with 67,509 additions and 345,780 deletions.
diff --git a/Blank_Rendered_Sample_Form_1.html b/Blank_Rendered_Sample_Form_1.html
diff --git a/Blank_Rendered_Sample_Form_1F.html b/Blank_Rendered_Sample_Form_1F.html
diff --git a/Blank_Rendered_Sample_Form_2.html b/Blank_Rendered_Sample_Form_2.html
diff --git a/Blank_Rendered_Sample_Form_2A.html b/Blank_Rendered_Sample_Form_2A.html
diff --git a/Blank_Rendered_Sample_Form_3Q_Electric.html b/Blank_Rendered_Sample_Form_3Q_Electric.html
diff --git a/Blank_Rendered_Sample_Form_3Q_Gas.html b/Blank_Rendered_Sample_Form_3Q_Gas.html
diff --git a/Blank_Rendered_Sample_Form_6.html b/Blank_Rendered_Sample_Form_6.html
diff --git a/Blank_Rendered_Sample_Form_60.html b/Blank_Rendered_Sample_Form_60.html
diff --git a/Blank_Rendered_Sample_Form_6Q.html b/Blank_Rendered_Sample_Form_6Q.html
diff --git a/Blank_Rendered_Sample_Form_714.html b/Blank_Rendered_Sample_Form_714.html
diff --git a/FERC-zips/Form 1_2023-04-01_976.zip b/FERC-zips/Form 1_2023-04-01_976.zip
diff --git a/FERC-zips/Form 2_2023-04-01_977.zip b/FERC-zips/Form 2_2023-04-01_977.zip
diff --git a/FERC-zips/Form 60_2023-04-01_974.zip b/FERC-zips/Form 60_2023-04-01_974.zip
diff --git a/FERC-zips/Form 6_2023-04-01_975.zip b/FERC-zips/Form 6_2023-04-01_975.zip
diff --git a/FERC-zips/Form 714_2023-04-01_973.zip b/FERC-zips/Form 714_2023-04-01_973.zip
diff --git a/README.md b/README.md
@@ -26,18 +26,18 @@ The FERC publihes different template sets for each form, including different tem
 
 In addition the FERC publishes seperate template sets for individual schedules.  This means a single schedule can be rendered for review rather than rendering the entire form.
 
-The latest templates for rendering are posted in this repository and linked under 'Assets' with each [release](../../releases).  The templates can also be used from this repository with the Arelle command below as the ferc-render-template-set parameter:
-
-- Form 1: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_1.zip
-- Form 1F: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_1F.zip
-- Form 1 3Q Electric: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_3Q_Electric.zip
-- Form 2: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_2.zip
-- Form 2A: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_2A.zip
-- Form 2 3Q Gas: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_3Q_Gas.zip
-- Form 6: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_6.zip
-- Form 6Q: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_6Q.zip
-- Form 60: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_60.zip
-- Form 714: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_714.zip
+The templates can also be used from this repository with the Arelle command below as the ferc-render-template-set parameter:
+
+- Form 1: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_1.zip
+- Form 1F: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_1F.zip
+- Form 1 3Q Electric: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_3Q_Electric.zip
+- Form 2: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_2.zip
+- Form 2A: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_2A.zip
+- Form 2 3Q Gas: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_3Q_Gas.zip
+- Form 6: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_6.zip
+- Form 6Q: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_6Q.zip
+- Form 60: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_60.zip
+- Form 714: https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_714.zip
 
 ### Arelle Commands to render the filing
 The command to generate a rendered filing is as follows (exclude the _{location}_ text - this is illustrative of which file is referenced):
@@ -61,13 +61,13 @@ This will refer to an external CSS file in the template. To include the css file
 These two options should be used by default.  To include FERC rendering CSS styles from the template in the head your rendered HTML, use ``--ferc-render-css-file = form-template.css`` along with the ``--ferc-render-inline-css`` command.  Excluding the ``--ferc-render-inline-css`` will generate a separate CSS file linked within the HTML. All FERC rendering templates use **form-template.css** as the default name for CSS files.
 
 ### Arelle Commands to render the HTML without an instance
-`.\arellecmdline.exe --plugin FERC/render --ferc-render-render --ferc-render-template-set https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates/Form_1.zip -f https://ecollection.ferc.gov/taxonomy/form1/2020-01-01/form/form1/form-1_2020-01-01.xsd --ferc-render-css-file {Location of CSS - this is in Arelle's FERC plugin folder}form-template.css --ferc-render-inline-css --ferc-render-inline {Location of output}/inline.html --noCertificateCheck --ferc-render-debug`
+`.\arellecmdline.exe --plugin FERC/render --ferc-render-render --ferc-render-template-set https://github.com/xbrlus/ferc-renderer/raw/master/RenderingTemplates_Form_1.zip -f https://ecollection.ferc.gov/taxonomy/form1/2023-04-01/form/form1/form-1_2023-04-01.xsd --ferc-render-css-file {Location of CSS - this is in Arelle's FERC plugin folder}form-template.css --ferc-render-inline-css --ferc-render-inline {Location of output}/inline.html --noCertificateCheck --ferc-render-debug`
 
 ## Validating a Filing
-FERC forms are validated during the submission process with a series of checks.  These validations can also be downloaded from [the repository's `ValidationRulesets' directory](ValidationRulesets/) and invoked as .zip files using Arelle and the xule processor *version 3.0.23221* or later. The command to validate a filing is as follows (exclude the _{location}_ text - this is illustrative of which file is referenced):
+FERC forms are validated during the submission process with a series of checks.  These validations can also be downloaded from [the repository's `ValidationRulesets' directory](ValidationRulesets/) and invoked as .zip files using Arelle and the xule processor *version 3.0.23570* or later. The command to validate a filing is as follows (exclude the _{location}_ text - this is illustrative of which file is referenced):
 
 `.\arellecmdline.exe --plugins xule --xule-rule-set {location of form ruleset}/Form1.zip -f {location of instance}/sampleF1.xbrl -v --xule-time .005 --xule-debug --noCertificateCheck --logFile {location of output}/log.xml`
 
 Like the rendering templates, the validation ruleset.zip files can be invoked from the repository by using the `/raw/` attribute in the URL:
 
-`.\arellecmdline.exe --plugins xule --xule-rule-set https://github.com/xbrlus/ferc-renderer/**raw/** master/ValidationRulesets/Form1.zip -f {location of instance}/sampleF1.xbrl -v --xule-time .005 --xule-debug --noCertificateCheck --logFile {location of output}/log.xml`
+`.\arellecmdline.exe --plugins xule --xule-rule-set https://github.com/xbrlus/ferc-renderer/**raw/** master/ValidationRuleset_Form1.zip -f {location of instance}/sampleF1.xbrl -v --xule-time .005 --xule-debug --noCertificateCheck --logFile {location of output}/log.xml`
diff --git a/Rendered_Sample_Form_1.html b/Rendered_Sample_Form_1.html
diff --git a/Rendered_Sample_Form_1F.html b/Rendered_Sample_Form_1F.html
diff --git a/Rendered_Sample_Form_2.html b/Rendered_Sample_Form_2.html
diff --git a/Rendered_Sample_Form_2A.html b/Rendered_Sample_Form_2A.html
diff --git a/Rendered_Sample_Form_3Q_Electric.html b/Rendered_Sample_Form_3Q_Electric.html