mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clarify and improve FAQs related to the author_handle

Browse Source 
Added "FAQ 6.13: How may I find my author handle?".

Improved author handle information in FAQ 5.5, 6.5, and 6.6.

Ran `make www` to perform test the above under macOS.
This commit is contained in:
Landon Curt Noll committed 2024-05-07 22:21:16 -07:00
1 parent f9055fe356
commit 5efe15998b
2 files changed
+98 -19
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+41 -9
View File
@@ -461,6 +461,7 @@ other inconsistencies with the original entry?</a></li>
<li><a href="#faq6_10">6.10 - How does someone make a change to a file and submit that change as a GitHub pull request?</a></li>
<li><a href="#faq6_11">6.11 - Am I allowed to use IOCCC content?</a></li>
<li><a href="#faq6_12">6.12 - What is Mastodon and why does IOCCC use it?</a></li>
<li><a href="#faq6_13">6.13 - How may I find my author handle?</a></li>
</ul>
<h1 id="the-ioccc-faq">The IOCCC FAQ</h1>
<div id="faq0">
@@ -2154,8 +2155,11 @@ then <strong>please <a href="faq.html#pull_request">submit a pull request</a></s
or at least <a href="contact.html">inform the IOCCC judges</a>.</p>
<p>Authors of IOCCC winning entries are kept in JSON files of the form:</p>
<pre><code> author/author_handle.json</code></pre>
<p>where <em>author_handle</em> is an author handle. See <a href="#author_handle">FAQ 6.5</a> for more
information about author handles.</p>
<p>where <em>author_handle</em> is an author handle.</p>
<p>See <a href="#author_handle_faq">FAQ 6.5</a> for more information about author handles.</p>
<p>See <a href="#author_json">FAQ 6.6</a> for information about the contents of these JSON file and
how they are used.</p>
<p>See <a href="#find_author_handle">FAQ 6.13</a> for how to find your own <em>author_handle</em>.</p>
<p>The contents of these JSON files contain the best known information
about authors of IOCCC entries. See <a href="#author_json">FAQ 6.6</a> for information
about the contents of these JSON file and how they are used.</p>
@@ -2286,16 +2290,22 @@ exaggeration</a>.</p>
IOCCC. Each author has exactly one <code>author_handle</code>.</p>
<p>For each <code>author_handle</code>, there will be a JSON file of the form:</p>
<pre><code> author/author_handle.json</code></pre>
<p>See <a href="#fix_author">FAQ 5.5</a> for information about how to update
and/or correct IOCCC author information.</p>
<p>See <a href="#author_json">FAQ 6.6</a> for information about the contents of these JSON file and
how they are used.</p>
<p>See <a href="#find_author_handle">FAQ 6.13</a> for how to find your own <em>author_handle</em>.</p>
<p>Because the <code>author_handle</code> is used to form a JSON filename, the string must be
POSIX safe string plus the use of <code>+</code> (for technical reasons beyond this
answer). In particular, the <code>author_handle</code> must be an ASCII string that
matches this regexp:</p>
answer). In particular, the <code>author_handle</code> must be an ASCII string or
32 characters or less that matches this regexp:</p>
<pre><code> ^[0-9A-Za-z][0-9A-Za-z._+-]*$&quot;</code></pre>
<p>Default <code>author_handle</code>’s do not have multiple consecutive <code>_</code> (underscore)
characters. Nevertheless, multiple consecutive <code>_</code> (underscore) characters are
allowed. Contest submitters who wish to override their default <code>author_handle</code> may do so.</p>
allowed. Contest submitters who wish to override their default <code>author_handle</code>
may do so, long as the ASCII string matches the regexp above AND
so long as the length does not exceed the 32 ASCII characters (not including
the terminating NUL byte).</p>
<p>The <code>author_handle</code> is derived from the name of the author. While there is a
algorithm that maps the name of the author (which can contain any UTF-8
characters) into a default <code>author_handle</code> string, those who submit an entry to
@@ -2314,8 +2324,6 @@ year.</p>
in the case of <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2005/anon/anon.c">2005/anon</a>.</p>
<p>Anonymous <code>author_handle</code>’s match this regexp:</p>
<pre><code> Anonymous_[0-9][0-9][0-9][0-9][.0-9]*$</code></pre>
<p>See <a href="#fix_author">FAQ 5.5</a> for information about how to update
and/or correct IOCCC author information.</p>
<div id="faq6_6">
<div id="author_json">
<h3 id="faq-6.6-what-is-a-author_handle.json-file-and-how-are-they-used">FAQ 6.6: What is a author_handle.json file and how are they used?</h3>
@@ -2336,7 +2344,7 @@ of the author’s JSON file for ways to contact them.</p>
<p>Each author of an IOCCC winning entry has their own <code>author_handle.json</code> file
of the form:</p>
<pre><code> author/author_handle.json</code></pre>
<p>where <em>author_handle</em> is an author handle. See <a href="#author_handle">FAQ 6.5</a> for more
<p>where <em>author_handle</em> is an author handle. See <a href="#author_handle_faq">FAQ 6.5</a> for more
information about an author handles.</p>
<h4 id="author_handle.json-json-file-contents">author_handle.json JSON file contents</h4>
<p>The syntax of a <code>author_handle.json</code> follows the <em>So-called JSON spec</em>.
@@ -2639,7 +2647,7 @@ names such as <em>winner</em> when they should use <em>author</em>. Sorry (tm Ca
<ul>
<li>Entry</li>
</ul>
<p>An <em>entry</em> is a submission that won the IOCCC.</p>
<p>An <em>entry</em> is a <em>submission</em> that won the IOCCC.</p>
<p>An <em>entry</em> has one or more <em>authors</em>.</p>
<p>An <em>entry</em> includes all of the files needed to compile it,
plus sample input files, a <code>Makefile</code>, an <code>.entry.json</code> file
@@ -2880,6 +2888,30 @@ and topics like science, technology, <a href="https://en.wikipedia.org/wiki/Free
have a good home. The <a href="https://fosstodon.org/@fosstodon">fosstodon.org</a> folk made the IOCCC feel welcome.</p>
<p>While using Mastodon is free, the <a href="judges.html">IOCCC judges</a> are pleased to
<a href="https://hub.fosstodon.org/support/">support the Fosstodon Hub</a>.</p>
<div id="faq6_13">
<div id="find_author_handle">
<h3 id="faq-6.13-how-may-i-find-my-author-handle">FAQ 6.13: How may I find my author handle?</h3>
</div>
</div>
<p>If you are an <em>author</em> of a winning <em>entry</em>, you may find your own <em>author_handle</em>
by going to your entry in the <a href="authors.html">authors.html</a> web page and viewing the string
that follows the <em>author_handle</em>: line.</p>
<p>If you are not someone who has won a previous IOCCC, you will be able to select
a potential <em>author_handle</em> when you form your <em>submission</em> tarball (see <a href="#submit">FAQ 0.0</a>).</p>
<p><strong>Helpful Hint</strong>: If an <em>author</em> clicks on their <em>author_handle:</em>
line link, you will be taken to that author’s <code>author_handle.json</code> file.</p>
<p>For example, <a href="authors.html#Brian_Westley">Brian Westley</a> can view his
author entry and see that his <em>author_handle</em> is <strong>Brian_Westley</strong>.
Clicking on the <em>author_handle</em> shows the contents of
the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/author/Brian_Westley.json">Brian_Westley.json</a> file.</p>
<p><strong>IMPORTANT NOTE</strong>: An <code>author</code> who has won a previous IOCCC is encouraged to reuse their
<code>author_handle</code> so that new winning entries can be associated with the same author.</p>
<p>See <a href="#fix_author">FAQ 5.5</a> for information about how to update
and/or correct IOCCC author information.</p>
<p>See <a href="#author_handle_faq">FAQ 6.5</a> for more information about author handles.</p>
<p>See <a href="#author_json">FAQ 6.6</a> for information about the contents of these JSON file and
how they are used.</p>
<p>See <a href="#terms">FAQ 6.9</a> for more information on terms such as <em>author</em>, <em>entry</em>, and <em>submission</em>.</p>
<hr style="width:10%;text-align:left;margin-left:0">
<p>Jump to: <a href="#">top</a></p>
<!--
faq.md
+57 -10
View File
@@ -84,6 +84,7 @@ other inconsistencies with the original entry?](#faq4_3)
- [6.10 - How does someone make a change to a file and submit that change as a GitHub pull request?](#faq6_10)
- [6.11 - Am I allowed to use IOCCC content?](#faq6_11)
- [6.12 - What is Mastodon and why does IOCCC use it?](#faq6_12)
- [6.13 - How may I find my author handle?](#faq6_13)
# The IOCCC FAQ
@@ -2586,8 +2587,14 @@ Authors of IOCCC winning entries are kept in JSON files of the form:
author/author_handle.json
```
where _author_handle_ is an author handle. See [FAQ 6.5](#author_handle) for more
information about author handles.
where _author_handle_ is an author handle.
See [FAQ 6.5](#author_handle_faq) for more information about author handles.
See [FAQ 6.6](#author_json) for information about the contents of these JSON file and
how they are used.
See [FAQ 6.13](#find_author_handle) for how to find your own _author_handle_.
The contents of these JSON files contain the best known information
about authors of IOCCC entries. See [FAQ 6.6](#author_json) for information
@@ -2772,13 +2779,18 @@ For each `author_handle`, there will be a JSON file of the form:
author/author_handle.json
```
See [FAQ 5.5](#fix_author) for information about how to update
and/or correct IOCCC author information.
See [FAQ 6.6](#author_json) for information about the contents of these JSON file and
how they are used.
See [FAQ 6.13](#find_author_handle) for how to find your own _author_handle_.
Because the `author_handle` is used to form a JSON filename, the string must be
POSIX safe string plus the use of `+` (for technical reasons beyond this
answer). In particular, the `author_handle` must be an ASCII string that
matches this regexp:
answer). In particular, the `author_handle` must be an ASCII string or
32 characters or less that matches this regexp:
``` <!---re-->
^[0-9A-Za-z][0-9A-Za-z._+-]*$"
@@ -2786,7 +2798,10 @@ matches this regexp:
Default `author_handle`'s do not have multiple consecutive `_` (underscore)
characters. Nevertheless, multiple consecutive `_` (underscore) characters are
allowed. Contest submitters who wish to override their default `author_handle` may do so.
allowed. Contest submitters who wish to override their default `author_handle`
may do so, long as the ASCII string matches the regexp above AND
so long as the length does not exceed the 32 ASCII characters (not including
the terminating NUL byte).
The `author_handle` is derived from the name of the author. While there is a
algorithm that maps the name of the author (which can contain any UTF-8
@@ -2823,9 +2838,6 @@ Anonymous `author_handle`'s match this regexp:
Anonymous_[0-9][0-9][0-9][0-9][.0-9]*$
```
See [FAQ 5.5](#fix_author) for information about how to update
and/or correct IOCCC author information.
<div id="faq6_6">
<div id="author_json">
@@ -2855,7 +2867,7 @@ of the form:
author/author_handle.json
```
where _author_handle_ is an author handle. See [FAQ 6.5](#author_handle) for more
where _author_handle_ is an author handle. See [FAQ 6.5](#author_handle_faq) for more
information about an author handles.
#### author_handle.json JSON file contents
@@ -3382,7 +3394,7 @@ names such as _winner_ when they should use _author_. Sorry (tm Canada)! :-)
- Entry
An _entry_ is a submission that won the IOCCC.
An _entry_ is a _submission_ that won the IOCCC.
An _entry_ has one or more _authors_.
@@ -3740,6 +3752,41 @@ While using Mastodon is free, the [IOCCC judges](judges.html) are pleased to
[support the Fosstodon Hub](https://hub.fosstodon.org/support/).
<div id="faq6_13">
<div id="find_author_handle">
### FAQ 6.13: How may I find my author handle?
</div>
</div>
If you are an _author_ of a winning _entry_, you may find your own _author_handle_
by going to your entry in the [authors.html](authors.html) web page and viewing the string
that follows the _author_handle_: line.
If you are not someone who has won a previous IOCCC, you will be able to select
a potential _author_handle_ when you form your _submission_ tarball (see [FAQ 0.0](#submit)).
**Helpful Hint**: If an _author_ clicks on their _author_handle:_
line link, you will be taken to that author's `author_handle.json` file.
For example, [Brian Westley](authors.html#Brian_Westley) can view his
author entry and see that his _author_handle_ is **Brian_Westley**.
Clicking on the _author_handle_ shows the contents of
the [Brian_Westley.json](%%REPO_URL%%/author/Brian_Westley.json) file.
**IMPORTANT NOTE**: An `author` who has won a previous IOCCC is encouraged to reuse their
`author_handle` so that new winning entries can be associated with the same author.
See [FAQ 5.5](#fix_author) for information about how to update
and/or correct IOCCC author information.
See [FAQ 6.5](#author_handle_faq) for more information about author handles.
See [FAQ 6.6](#author_json) for information about the contents of these JSON file and
how they are used.
See [FAQ 6.9](#terms) for more information on terms such as _author_, _entry_, and _submission_.
<hr style="width:10%;text-align:left;margin-left:0">
Jump to: [top](#)