Moved the HOWTO out of the HTML source (#645)

w3c · Aug 14, 2024 · 77d8243 · 77d8243
1 parent 128b807
commit 77d8243
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 44 deletions.
diff --git a/HOWTO.md b/HOWTO.md
@@ -0,0 +1,61 @@
+# The Fu to edit the transition requirements 
+
+HTML elements are displayed or not based on the user selection.
+
+When an option is selected, it updates the URL of the document with a new set of parameters. Those parameters are reflected within the HTML document using the @data attributes.
+
+So far, we have the following data attributes (each matching a URL parameter):
+
+1. data-profile for a |-separated list of profile
+2. data-rec for a |-separated list of REC paths
+3. data-cr for a |-separated list of CR paths
+3. data-informativeOnly for a |-separated list of FPWD and WD paths
+4. data-returning for a |-separated list of FPWD and WD paths
+5. data-notehistory for a |-separated list of first [working|interest] group note paths
+7. data-echidna for automatic publishing
+
+If no data attributes are not present, the element will get displayed for all possible states within the scope of the parent element. For example, to display an element for all types of Recommendations, use data-profile="rec"
+and don't use the data-rec attribute on that element.'
+
+e.g.
+``
+<div id='d1' data-profile="CR">
+  <p id='e1'>This is a new publication.</p>
+  <p id='e2' data-profile="CR" data-cr="new|snapshot">It will a snapshot (which might be the first snapshot).</p>
+  <p id='e3' data-profile="CR" data-cr="draft">It will be a draft.</p>
+  <p id='e4' data-profile="REC">This is bogus.</p>
+</div>
+``
+
+* d1 and e1 will get displayed if the user selected any of the Candidate Recommendation options (the URL contains the parameter profile=CR ).
+* e2 will get displayed only for snapshots, including the first one.
+* e3 will get displayed only for CR drafts.
+* e4 will never get displayed since the scope of its parent element is CR (and a document can't be a CR and a REC at the same time).
+
+To find the possible values for each data attribute, look at the HTML option and input HTML elements in [the document](https://github.com/w3c/transitions/blob/main/index.html#L269). Or, if you're looking for a particular document transition, use the form to select and see the values of the URL parameters.
+
+If data attributes are used, one of them must be @data-profile, otherwise the other data attributes will be ignored.
+
+# New W3C Process
+
+To add or remove a document status, one must:
+
+1. remove or add the status in the HTML option elements (id="profile")
+2. add or remove HTML input elements if applicable
+3. Update the data-profile attributes
+4. If HTML input elements were added or removed:
+  a- update the corresponding data- attributes
+  b- update the config object near the top of the script
+  c- update the JS functions onpushstate (URL) and titleMatch (attribute matching)
+
+# New Echidna updates
+
+For echidna updates:
+1. Update data-profile on the ul element with id='echidna-selection"
+2. Update the data-echidna as needed (you're likely to add data-echidna="false"')
+3- Update the JS function hasEchidna()
+
+# History
+
+The transition requirements document is originally based on
+ https://services.w3.org/xslt?xmlfile=https://www.w3.org/2005/08/01-transitions2017.html&xslfile=https://www.w3.org/2005/08/transitions2017.xsl
diff --git a/index.html b/index.html
@@ -2667,50 +2667,6 @@ <h2 id="call-for-exclusions">Call for Exclusions</h2>
 			trace("restored " + window.location.href);
 		})();
 	</script>
-	<!--
-
-HTML elements are turned on or off by scripting using data attributes.
-
-So far, we have the following data attributes:
-1. data-profile for a |-separated list of profile
-2. data-rec for a |-separated list of REC paths
-3. data-cr for a |-separated list of CR paths
-3. data-informativeOnly for a |-separated list of FPWD and WD paths
-4. data-returning for a |-separated list of FPWD and WD paths
-5. data-notehistory for a |-separated list of first [working|interest] group note paths
-7. data-echidna for automatic publishing
-
-e.g.
-<div data-profile="FPWD|FPIG-NOTE|FPWG-NOTE|CR|PR|REC|PR-OBSL|PR-RSCND|OBSL|RSCND" data-cr="new|snapshot" data-notehistory="first">
-
-To find the possible values for each data attributes, look at the HTML option and input elements.
-
-If a data attribute is not present, it means the element will get displayed for all states
-of that attribute. eg to display an element for all types of Recommendations, use data-profile="rec"
-and don't use the data-rec attribute on that element.'
-
-If data attributes are used, one of them must be data-profile, otherwise the other data
-attributes will be ignored.
-
-To add or remove a document status, one must:
-
-1. remove or add the status in the HTML option elements (id="profile")
-2. add or remove HTML input elements if applicable
-3. Update the data-profile attributes
-4. If HTML input elements were added or removed:
-  a- update the corresponding data- attributes
-  b- update the config object near the top of the script
-  c- update the JS functions onpushstate (URL) and titleMatch (attribute matching)
-
-For echidna updates:
-1. Update data-profile on the ul element with id='echidna-selection"
-2. Update the data-echidna as needed (you're likely to add data-echidna="false"')
-3- Update the JS function hasEchidna()
-
-Originally based on
- https://services.w3.org/xslt?xmlfile=https://www.w3.org/2005/08/01-transitions2017.html&xslfile=https://www.w3.org/2005/08/transitions2017.xsl
-
-	-->
 </body>
 
 </html>