Fossil SCM
Add notes to fileformat.wiki explaining why tags on forumpost artifacts should generally be applied to the first version of a post instead of an edited version.
Commit
051af7e32301fb8fb3a87f6f2742e912f682939ab8f14cc49a4a45f84cb50c00
Parent
fbab27b0b742ac5…
1 file changed
+21
-6
+21
-6
| --- www/fileformat.wiki | ||
| +++ www/fileformat.wiki | ||
| @@ -438,16 +438,19 @@ | ||
| 438 | 438 | <b>N</b> <i>mimetype</i><br /> |
| 439 | 439 | <b>U</b> <i>user-name</i><br /> |
| 440 | 440 | <b>Z</b> <i>checksum</i> |
| 441 | 441 | </div> |
| 442 | 442 | |
| 443 | -The <b>A</b> card specifies a filename for the attachment in its first argument. | |
| 444 | -The second argument to the <b>A</b> card is the name of the wiki page, | |
| 445 | -ticket, technical note, or forum post to which the attachment is connected. The | |
| 446 | -third argument is either missing or else it is the lower-case artifact | |
| 447 | -ID of the attachment itself. A missing third argument means that the | |
| 448 | -attachment should be deleted. | |
| 443 | +The <b>A</b> card specifies a filename for the attachment in its first | |
| 444 | +argument. The second argument to the <b>A</b> card is the name of the | |
| 445 | +wiki page, ticket, technical note, or full hash of a forum post to | |
| 446 | +which the attachment is connected. The third argument is either | |
| 447 | +missing or else it is the lower-case artifact ID of the attachment | |
| 448 | +itself. A missing third argument means that the attachment should be | |
| 449 | +deleted. If <i>source</i> is a forum post, the hash provided should | |
| 450 | +generally be the hash of the first version of the post for reasons | |
| 451 | +[#forumpost-tag|explained below]. | |
| 449 | 452 | |
| 450 | 453 | The <b>C</b> card is an optional comment describing what the attachment is about. |
| 451 | 454 | The <b>C</b> card is optional, but there can only be one. |
| 452 | 455 | |
| 453 | 456 | A single <b>D</b> card is required to give the date and time when the attachment |
| @@ -602,10 +605,22 @@ | ||
| 602 | 605 | The format of the <b>W</b> card is exactly the same as for a |
| 603 | 606 | [#wikichng | wiki artifact]. |
| 604 | 607 | |
| 605 | 608 | The <b>Z</b> card is the required checksum over the rest of the artifact. |
| 606 | 609 | |
| 610 | +<a name="forumpost-tag"></a> | |
| 611 | +<strong>Forum posts and tags:</strong> | |
| 612 | + | |
| 613 | +When adding [#ctrl|tags] to forum posts it is generally up to the | |
| 614 | +application to tag only the first version of any given post. For | |
| 615 | +example, if post X has two edits, a tag applied by the user to X+2 | |
| 616 | +should generally be applied to version X instead. Though this | |
| 617 | +complicates the app logic for applying tags, it simplifies the app's | |
| 618 | +location of tags. As of this writing (May 2026), no current Fossil | |
| 619 | +use cases would be improved by tagging specific subsequent versions of | |
| 620 | +posts, e.g. our hypothetical X+1. | |
| 621 | + | |
| 607 | 622 | |
| 608 | 623 | <h2 id="summary">3.0 Card Summary</h2> |
| 609 | 624 | |
| 610 | 625 | The following table summarizes the various kinds of cards that appear |
| 611 | 626 | on Fossil artifacts. A blank entry means that combination of card and |
| 612 | 627 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -438,16 +438,19 @@ | |
| 438 | <b>N</b> <i>mimetype</i><br /> |
| 439 | <b>U</b> <i>user-name</i><br /> |
| 440 | <b>Z</b> <i>checksum</i> |
| 441 | </div> |
| 442 | |
| 443 | The <b>A</b> card specifies a filename for the attachment in its first argument. |
| 444 | The second argument to the <b>A</b> card is the name of the wiki page, |
| 445 | ticket, technical note, or forum post to which the attachment is connected. The |
| 446 | third argument is either missing or else it is the lower-case artifact |
| 447 | ID of the attachment itself. A missing third argument means that the |
| 448 | attachment should be deleted. |
| 449 | |
| 450 | The <b>C</b> card is an optional comment describing what the attachment is about. |
| 451 | The <b>C</b> card is optional, but there can only be one. |
| 452 | |
| 453 | A single <b>D</b> card is required to give the date and time when the attachment |
| @@ -602,10 +605,22 @@ | |
| 602 | The format of the <b>W</b> card is exactly the same as for a |
| 603 | [#wikichng | wiki artifact]. |
| 604 | |
| 605 | The <b>Z</b> card is the required checksum over the rest of the artifact. |
| 606 | |
| 607 | |
| 608 | <h2 id="summary">3.0 Card Summary</h2> |
| 609 | |
| 610 | The following table summarizes the various kinds of cards that appear |
| 611 | on Fossil artifacts. A blank entry means that combination of card and |
| 612 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -438,16 +438,19 @@ | |
| 438 | <b>N</b> <i>mimetype</i><br /> |
| 439 | <b>U</b> <i>user-name</i><br /> |
| 440 | <b>Z</b> <i>checksum</i> |
| 441 | </div> |
| 442 | |
| 443 | The <b>A</b> card specifies a filename for the attachment in its first |
| 444 | argument. The second argument to the <b>A</b> card is the name of the |
| 445 | wiki page, ticket, technical note, or full hash of a forum post to |
| 446 | which the attachment is connected. The third argument is either |
| 447 | missing or else it is the lower-case artifact ID of the attachment |
| 448 | itself. A missing third argument means that the attachment should be |
| 449 | deleted. If <i>source</i> is a forum post, the hash provided should |
| 450 | generally be the hash of the first version of the post for reasons |
| 451 | [#forumpost-tag|explained below]. |
| 452 | |
| 453 | The <b>C</b> card is an optional comment describing what the attachment is about. |
| 454 | The <b>C</b> card is optional, but there can only be one. |
| 455 | |
| 456 | A single <b>D</b> card is required to give the date and time when the attachment |
| @@ -602,10 +605,22 @@ | |
| 605 | The format of the <b>W</b> card is exactly the same as for a |
| 606 | [#wikichng | wiki artifact]. |
| 607 | |
| 608 | The <b>Z</b> card is the required checksum over the rest of the artifact. |
| 609 | |
| 610 | <a name="forumpost-tag"></a> |
| 611 | <strong>Forum posts and tags:</strong> |
| 612 | |
| 613 | When adding [#ctrl|tags] to forum posts it is generally up to the |
| 614 | application to tag only the first version of any given post. For |
| 615 | example, if post X has two edits, a tag applied by the user to X+2 |
| 616 | should generally be applied to version X instead. Though this |
| 617 | complicates the app logic for applying tags, it simplifies the app's |
| 618 | location of tags. As of this writing (May 2026), no current Fossil |
| 619 | use cases would be improved by tagging specific subsequent versions of |
| 620 | posts, e.g. our hypothetical X+1. |
| 621 | |
| 622 | |
| 623 | <h2 id="summary">3.0 Card Summary</h2> |
| 624 | |
| 625 | The following table summarizes the various kinds of cards that appear |
| 626 | on Fossil artifacts. A blank entry means that combination of card and |
| 627 |