Diff of /xml/iffy/index.html

Revision 72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0 => current


Line72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0current
1<!DOCTYPE html><!DOCTYPE html>
2<html><html>
3 <head> <head>
49 <h1><a href="index.html">The 'iffy' XML namespace</a></h1> <h1><a href="index.html">The 'iffy' XML namespace</a></h1>
50 <hr class="below-title"> <hr class="below-title">
51 </div> </div>
52 <div class="update-prepend"> <div class="update-prepend rss-description-exclude">
53 <em> ➣  This post was meaningfully revised at 2024-05-25 @ 11:00 PM EDT. The previous revision is <a href="index-oldcommit-13de0232319ceab2f830591c318089d18cbec78d.html">here</a>. <br> <em> ➣  This post was meaningfully revised at 2024-06-01 @ 09:35 PM EDT. The previous revision is <a href="index-oldcommit-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0.html">here</a>. (See <a href="index.html#update-history">update history</a>.) <br>
54 ➣  This post is expected to evolve over time. You can subscribe to ongoing updates <a href="index-sprout.rss">here</a>. ➣  This post is expected to evolve over time. You can subscribe to ongoing updates <a href="index-sprout.rss">here</a>.
55 <link rel="alternate" type="application/rss+xml" title="Update to The 'iffy' XML namespace" href="https://tech.interfluidity.com/xml/iffy/index-sprout.rss"></em> <link rel="alternate" type="application/rss+xml" title="Update to The 'iffy' XML namespace" href="https://tech.interfluidity.com/xml/iffy/index-sprout.rss"></em>
56 <hr> <hr>
66 <p><strong>Table of Contents</strong></p> <p><strong>Table of Contents</strong></p>
67 <ul> <ul>
68 <li><a href="#iffy-completeness"><code>iffy:completeness</code></a></li> <li><a href="#iffy-completeness"><code>iffy:completeness</code></a></li>
69 <li><a href="#iffy-diff"><code>iffy:diff</code></a></li>
70 <li><a href="#iffy-initial"><code>iffy:initial</code></a></li>
71 <li><a href="#iffy-provenance"><code>iffy:provenance</code></a></li> <li><a href="#iffy-provenance"><code>iffy:provenance</code></a></li>
72 <li><a href="#iffy-revision"><code>iffy:revision</code></a></li>
73 <li><a href="#iffy-timestamp"><code>iffy:timestamp</code></a></li>
74 <li><a href="#iffy-update"><code>iffy:update</code></a></li>
75 <li><a href="#iffy-update-history"><code>iffy:update-history</code></a></li>
76 </ul> </ul>
77 <hr> <hr>
78 <p><a id="iffy-completeness" href=""></a><strong>Element — <code>iffy:completeness</code></strong></p> <p><a id="iffy-completeness" href=""></a><strong>Element — <code>iffy:completeness</code></strong></p>
117</code></pre></code></pre>
118 </div> </div>
119 <hr> <hr>
120 <p><a id="iffy-diff" href=""></a><strong>Element — <code>iffy:diff</code></strong></p>
121 <div class="iffy-element-desc">
122 <p><strong>When a subelement of <a href="#iffy-update-history"><code>iffy:update</code></a></strong></p>
123 <p>MUST contain a URL, URI, or <a href="https://datatracker.ietf.org/doc/html/rfc3987">IRI</a> of a human-reviewable a <a href="https://en.wikipedia.org/wiki/Diff"><em>diff</em></a> of the current updated and <em>the final minor revision</em> of the update prior (or of the initially published post, if the current update is the first declared update).</p>
124 <p><strong>Example</strong>:</p>
125 <pre><code class="language-xml"><iffy:diff>https://tech.interfluidity.com/xml/iffy/index-diff-394986cb8d9c57f567d324e691a44d50102101ce-to-13de0232319ceab2f830591c318089d18cbec78d.html</iffy:diff>
126</code></pre>
127 <p>See also <a href="#iffy-update-history"><code>iffy:update-history</code> example</a>.</p>
128 </div>
129 <hr>
130 <p><a id="iffy-initial" href=""></a><strong>Element — <code>iffy:initial</code></strong></p>
131 <div class="iffy-element-desc">
132 <p><strong>When a subelement of <a href="#iffy-update-history"><code>iffy:update-history</code></a></strong></p>
133 <p>MAY contain a sequence of <a href="https://www.rssboard.org/rss-profile#namespace-elements-dublin-creator"><code>dc:creator</code></a> elements, defining the initial authorship of an item, if authorship has changed. Since the containing <code>item</code> should always reflect current authorship (that of the most recent revision), but no <a href="#iffy-update"><code>iffy:update</code></a> element is defined for the initially published version, this container is required for completeness.</p>
134 <p><strong>Example</strong>:</p>
135 <pre><code class="language-xml"><iffy:initial>
136 <!-- Perhaps more recent updates, and the current item, include more authors -->
137 <dc:creator>First Author, Esq.</dc:creator>
138</iffy:initial>
139</code></pre>
140 </div>
141 <hr>
142 <p><a id="iffy-provenance" href=""></a><strong>Element — <code>iffy:provenance</code></strong></p> <p><a id="iffy-provenance" href=""></a><strong>Element — <code>iffy:provenance</code></strong></p>
143 <div class="iffy-element-desc"> <div class="iffy-element-desc">
144 <p><strong>When an item level element</strong></p> <p><strong>When an item level element</strong></p>
175</code></pre></code></pre>
176 </div> </div>
177 <hr> <hr>
178 <p><a id="iffy-revision" href=""></a><strong>Element — <code>iffy:revision</code></strong></p>
179 <div class="iffy-element-desc">
180 <p>MUST contain a URL, URI, or <a href="https://datatracker.ietf.org/doc/html/rfc3987">IRI</a> of a either a fixed past revision or the current (potentially evolving) revision of an item.</p>
181 <p><strong>Example</strong>:</p>
182 <pre><code class="language-xml"><iffy:revision>https://tech.interfluidity.com/xml/iffy/index-oldcommit-13de0232319ceab2f830591c318089d18cbec78d.html</iffy:revision>
183</code></pre>
184 <p>See also <a href="#iffy-update-history"><code>iffy:update-history</code> example</a>.</p>
185 </div>
186 <hr>
187 <p><a id="iffy-timestamp" href=""></a><strong>Element — <code>iffy:timestamp</code></strong></p>
188 <div class="iffy-element-desc">
189 <p>MUST contain an <a href="https://datatracker.ietf.org/doc/html/rfc3339">RFC3339</a> date-time construction.</p>
190 <p>Formatting and constraints are identical to those described for <a href="https://datatracker.ietf.org/doc/html/rfc4287#section-3.3">atom date constructs</a>.</p>
191 <p><strong>Example</strong>:</p>
192 <pre><code class="language-xml"><iffy:timestamp>2003-12-13T18:30:02Z</iffy:timestamp>
193<iffy:timestamp>2003-12-13T18:30:02+01:00</iffy:timestamp>
194</code></pre>
195 <p>See also <a href="#iffy-update-history"><code>iffy:update-history</code> example</a>.</p>
196 </div>
197 <hr>
198 <p><a id="iffy-update" href=""></a><strong>Element — <code>iffy:update</code></strong></p>
199 <div class="iffy-element-desc">
200 <p><strong>When a sub-element of <a href="#iffy-update-history"><code>iffy:update-history</code></a></strong></p>
201 <p>MUST contain one <a href="#iffy-timestamp"><code>iffy:timestamp</code></a> element.</p>
202 <p>MAY also contain one each of</p>
203 <ul>
204 <li><a href="https://datatracker.ietf.org/doc/html/rfc4287#section-4.2.13"><code>atom:summary</code></a></li>
205 <li><a href="#iffy-diff"><code>iffy:diff</code></a></li>
206 <li><a href="#iffy-revision"><code>iffy:revision</code></a></li>
207 </ul>
208 <p>MAY, but usually will not, contain any number of <a href="https://www.rssboard.org/rss-profile#namespace-elements-dublin-creator"><code>dc:creator</code></a> elements, reflecting <em>authorship specific to this revision</em>. By default, an update's authors are the same as the authorship of the containing item, which always reflects the curren revisions authors. If authorship is evolving over time, it SHOULD be specified for every update except the most recent one. Initial authorship may be specified in an <a href="#iffy-initial"><code>iffy:initial</code></a> element.</p>
209 <p><strong><em>Typo fixes, small rephrasings, and other tweaks are not expected to be recorded as distinct updates. That is, within a "single update" there may be a sequence of smaller revisions that go unrecorded.</em></strong> Applications that want a more forensic history might consider including and exposing every published change in version control.</p>
210 <p>See <a href="#iffy-update-history"><code>iffy:update-history</code> example</a>.</p>
211 </div>
212 <hr>
213 <p><a id="iffy-update-history" href=""></a><strong>Element — <code>iffy:update-history</code></strong></p>
214 <div class="iffy-element-desc">
215 <p><strong>When an item level element</strong></p>
216 <p>SHOULD contain a sequence of <a href="#iffy-update"><code>iffy:update</code></a> elements, in reverse chronological order, describing the histories of <em>major revisions</em> to an item.</p>
217 <p>MAY contain one <a href="#iffy-initial"><code>iffy:initial</code></a> element.</p>
218 <p>Items containing an <code>iffy:update-history</code> SHOULD also include an <a href="https://datatracker.ietf.org/doc/html/rfc4287#section-4.2.15"><code>atom:updated</code></a> tag corresponding to the most recent update.</p>
219 <p><strong><em>Typo fixes, small rephrasings, and other minor tweaks need not be recorded as distinct updates. That is, within a "single update" there may be a sequence of smaller revisions that go unrecorded.</em></strong> Applications that want a more forensic history might consider including and exposing every published change in version control.</p>
220 <p><a id="iffy-update-history-example" href=""></a><strong>Example</strong>:</p>
221 <pre><code class="language-xml"><item>
222 <iffy:update-history>
223 <iffy:update>
224 <iffy:timestamp>2024-06-02T03:00:00Z</iffy:timestamp>
225 <atom:summary><![CDATA[Add tags related to updates and revisions.]]></atom:summary>
226 <iffy:revision>
227 https://tech.interfluidity.com/xml/iffy/index-oldcommit-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0.html
228 </iffy:revision>
229 <iffy:diff>
230 https://tech.interfluidity.com/xml/iffy/index-diff-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0-to-current.html
231 </iffy:diff>
232 </iffy:update>
233 <iffy:update>
234 <iffy:timestamp>2024-05-26T03:00:00Z</iffy:timestamp>
235 <atom:summary><![CDATA[Add JS/CSS so that prior revisions are visually distinct from current.]]></atom:summary>
236 <iffy:revision>
237 https://tech.interfluidity.com/xml/iffy/index-oldcommit-13de0232319ceab2f830591c318089d18cbec78d.html
238 </iffy:revision>
239 <iffy:diff>
240 https://tech.interfluidity.com/xml/iffy/index-diff-13de0232319ceab2f830591c318089d18cbec78d-to-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0.html
241 </iffy:diff>
242 </iffy:update>
243 <iffy:update>
244 <iffy:timestamp>2024-05-24T04:25:00Z</iffy:timestamp>
245 <atom:summary>
246 <![CDATA[Drop tags <code>iffy:when-updated</code> and <code>iffy:original-guid</code>, bad appraoch to updates.]]>
247 </atom:summary>
248 <iffy:revision>
249 https://tech.interfluidity.com/xml/iffy/index-oldcommit-394986cb8d9c57f567d324e691a44d50102101ce.html
250 </iffy:revision>
251 <iffy:diff>
252 https://tech.interfluidity.com/xml/iffy/index-diff-394986cb8d9c57f567d324e691a44d50102101ce-to-13de0232319ceab2f830591c318089d18cbec78d.html
253 </iffy:diff>
254 </iffy:update>
255 </iffy:update-history>
256</item>
257</code></pre>
258 </div>
259 </div> </div>
260 </div> </div>
261 <div class="entry-footer"> <div class="entry-footer">
262 <div class="post-metainfo"> <div class="post-metainfo">
263 <a href="index.html">04:10 AM EDT</a> <a href="index.html">04:10 AM EDT</a>
264 <div class="updated-note"> <div class="updated-note">
265 <a href="index.html#major-updates">Last major update at 2024-05-25 @ 11:00 PM EDT</a> <a href="index.html#major-updates">Last major update at 2024-06-01 @ 09:35 PM EDT</a>
266 </div> </div>
267 </div> </div>
268 </div> </div>
278 <div class="next"> <div class="next">
279 </div> </div>
280 </div> </div>
281 <div class="update-history"> <div id="update-history" class="update-history">
282 <h3 class="update-history-title"><a id="major-updates" href=""></a>Major revisions:</h3> <h3 class="update-history-title"><a id="major-updates" href=""></a>Major revisions:</h3>
283 <ul> <ul>
284 <li><span class="update-timestamp"><i>2024-05-25 @ 11:00 PM EDT</i></span> — Add JS/CSS so that prior revisions are visually distinct from current. (<a href="index-diff-13de0232319ceab2f830591c318089d18cbec78d-to-current.html">diff</a>)</li> <li><span class="update-timestamp"><i>2024-06-01 @ 09:35 PM EDT</i></span> — Add initial take on tags related to updates and revisions. (<a href="index-diff-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0-to-current.html">diff</a>)</li>
285 <li><span class="update-timestamp"><i> <a href="index-oldcommit-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0.html">2024-05-25 @ 11:00 PM EDT</a></i></span> — Add JS/CSS so that prior revisions are visually distinct from current. (<a href="index-diff-13de0232319ceab2f830591c318089d18cbec78d-to-72eaf9fdfebc9e627bff33bbe1102d4d250ad1d0.html">diff</a>)</li>
286 <li><span class="update-timestamp"><i> <a href="index-oldcommit-13de0232319ceab2f830591c318089d18cbec78d.html">2024-05-24 @ 12:25 AM EDT</a></i></span> — Drop tags <code>iffy:when-updated</code> and <code>iffy:original-guid</code>, bad appraoch to updates. (<a href="index-diff-394986cb8d9c57f567d324e691a44d50102101ce-to-13de0232319ceab2f830591c318089d18cbec78d.html">diff</a>)</li> <li><span class="update-timestamp"><i> <a href="index-oldcommit-13de0232319ceab2f830591c318089d18cbec78d.html">2024-05-24 @ 12:25 AM EDT</a></i></span> — Drop tags <code>iffy:when-updated</code> and <code>iffy:original-guid</code>, bad appraoch to updates. (<a href="index-diff-394986cb8d9c57f567d324e691a44d50102101ce-to-13de0232319ceab2f830591c318089d18cbec78d.html">diff</a>)</li>
287 <li><span class="update-timestamp"><i> <a href="index-oldcommit-394986cb8d9c57f567d324e691a44d50102101ce.html">2024-05-13 @ 04:10 AM EDT</a></i></span> — Initial publication.</li> <li><span class="update-timestamp"><i> <a href="index-oldcommit-394986cb8d9c57f567d324e691a44d50102101ce.html">2024-05-13 @ 04:10 AM EDT</a></i></span> — Initial publication.</li>
288 </ul> </ul>
297 </div> </div>
298 </body> </body>
299</html></html>