350 Commits
Author SHA1 Message Date
Cody Boone Ferguson 27a6cc8c07 Add FAQ 4.5 - about alt versions being added 2024-05-24 09:33:39 -07:00
Cody Boone Ferguson 2daae15a8a Typo fix in FAQ 3.9 title
It ended up being just:

    3.9 - How do I compile an IOCCC entry that requires (n)?

instead of:

    3.9 - How do I compile an IOCCC entry that requires (n)curses?

and this has been corrected.
2024-05-14 05:33:10 -07:00
Landon Curt Noll a53b6cba9c Improved FAQ 5.5 related to unknown and anonymous locations
Ran `make www` to perform test the above under macOS.
2024-05-07 22:43:01 -07:00
Landon Curt Noll 5efe15998b clarify and improve FAQs related to the author_handle
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.
2024-05-07 22:21:16 -07:00
Cody Boone Ferguson 6c3be16620 Typo fix in FAQ 4.1
The text in markdown was gets(3( which resulted in gets((
rather than gets().
2024-05-05 09:55:56 -07:00
Landon Curt Noll 57dca5525b fix broken markdown local links in faq.md
Ran `make gen_top_html` to perform the above.
2024-04-28 14:43:30 -07:00
Landon Curt Noll 217836e33f fix even more broken markdown links
Added `bin/find-missing-links.sh` tool to check for
markdown links to missing local files.

Regarding the missing link tool:

```
    Here be extended regular expression magic dragons! :-)
```

Added `make find_missing_links` to the top level Makefile.

Added `make find_missing_links` to `make www` and `make quick_www`.

Ran `make www` to perform the above.

TODO: Fix markdown links to missing local files.
2024-04-28 01:08:21 -07:00
Landon Curt Noll 8bca099534 fix more broken markdown links
Fixed stuff we broke by mistake, previously.

Ran `make www` to perform the above.

TODO: Fix stuff we broke by mistake doing the above.

TODO: Fix more broken markdown links.
2024-04-26 16:25:17 -07:00
Landon Curt Noll 4f95e3f3d6 fix more broken markdown links
We fix more markdown links in markdown files that refer to files
internally to the web site.

Added tmp tools to find and print various markdown links:

* `tmp/md-links.sh` - print all markdown links
* `tmp/md-token-links.sh` - print all markdown links that start with a **%%TOKEN%%**
* `tmp/md-local-links.sh` - print all markdown links to a local file
* `tmp/md-link-paths.sh` - print local file paths referenced in markdown links

Fixed a number of markdown formatting problems with `thanks-for-help.md`.
Fixed markdown links to files in `thanks-for-help.md`.  Improved
heading levels in `thanks-for-help.md`, and made entry sections consistent.

Changed all markdown links that end in "))" to end in a better way.

Explained in `markdown.md` why we are avoiding markdown links that
end in "))".

Ran `make www` to perform the above.

TODO: Fix stuff we broke by mistake doing the above.

TODO: Fix more broken markdown links.
2024-04-26 04:17:20 -07:00
Cody Boone Ferguson a4e1b63695 Typo fix in FAQ 2024-04-25 06:44:58 -07:00
Landon Curt Noll 0171269115 improve FAQ on What platform should I assume for my entry
Added `faq.html#SUS` link.

Ran `make gen_top_html` to perform the above.
2024-04-21 19:04:30 -07:00
Landon Curt Noll 9ed9f57107 tone down FAQ on themes
We toned down the FAQ 0.1 entry, referring instead to
_frequently submitted_ themes and providing suggestions
to those who wish to try and submit such entries.

Run `make gen_top_html` to perform the above.
2024-04-21 18:54:59 -07:00
Landon Curt Noll 83a24fd01f change years.html#entry_id links to entry's index.html page 2024-04-21 17:11:14 -07:00
Landon Curt Noll b722b9249c fix bogus use of ../ in URLs of top level markdown files 2024-04-21 16:34:44 -07:00
Landon Curt Noll 521a852e24 improve news.html and mastodon info
Added "2024-04-20" news update.

Fixed format for "2023-05-22" news.

Fixed bad links to `judges.html`.

Add "Jump to: top" near the bottom.

The `make gen_top_html` no longer builds `next/rules.html`
nor `next/guidelines.html`.  This is being done by
the `bin/gen-status.sh` tool and `make gen_status`.

Moved `make gen_top_html` after `make gen_status` in the top level
Makefile rules for `make www` and `make quick_www` because
`bin/gen-status.sh` uses the modification date of `news.html` (that
make gen_top_html might modify) when forming `status.json`.

Added FAQ 6.12 for "What is Mastodon and why does IOCCC use it?".

Simplified `contact.html` mastodon info to refer the above FAQ
for further mastodon information.

Changed `bin/gen-top-html.sh` VERSION from "1.4.2 2024-04-21"
to "1.4.3 2024-04-21".

The `bin/gen-status.sh` tool will build `next/rules.html` and/or
`next/guidelines.html` if they are missing or empty.

Changed `bin/gen-status.sh` VERSION from "1.3 2024-04-14"
to "1.4 2024-04-21".

Run `make gen_top_html gen_status` to perform the above.
2024-04-21 15:32:04 -07:00
Landon Curt Noll 93d32d32e0 improve location.html
Add request for help for the "ZZ - Unknown location" authors.

Add "Jump to: top" near the bottom.

Changed `bin/gen-location.sh` VERSION from to "1.3 2024-04-16"
to "1.4 2024-04-21".

Improved FAQ 5.5, asking for help for ZZ location authors
and making better references to FAQ 6.10 about pull requests.

Run `make gen_location gen_top_html` to perform the above.
2024-04-21 14:00:12 -07:00
Landon Curt Noll bb19f88222 add markdown.md and markdown.html
Add `markdown.md` which generates `markdown.html`
to document IOCCC markdown best practices.

Changed `bin/gen-top-html.sh` VERSION from to "1.4.1 2024-04-16"
to "1.4.2 2024-04-21".

Added FAQ 0.6 about IOCCC mark requirements.

Run `make gen_top_html timestamp` to perform the above.
2024-04-21 02:54:54 -07:00
Cody Boone Ferguson 4fe6d18673 Typo fix in FAQ 2024-04-19 17:03:00 -07:00
Landon Curt Noll cb66b238d7 add link to CommonMark Spec in FAQ 2024-04-19 01:04:35 -07:00
Landon Curt Noll 39ce906d42 fix another duplicate HTML IDs in faq.html
Ran `make gen_top_html` to perform the above.
2024-04-18 16:14:19 -07:00
Landon Curt Noll c60aaa3c8a fix duplicate HTML IDs in faq.html
Ran `make gen_top_html` to perform the above.
2024-04-18 16:08:29 -07:00
Landon Curt Noll 112e35a1b5 fix formatting of faq.html
Attempted to fix formatting problems of `faq.html`
that was introduced in commit 476b0d45f0.

Run `make gen_top_html` to perform the above and test under macOS.
2024-04-16 21:49:53 -07:00
Landon Curt Noll 51038961cb replace obsolete a name tags with div
This HTML is now obsolete in HTML 5:

```html
<a name="faq0"></a>Section 0: Submitting entries to a new IOCCC
```

Instead we need to use the div HTML elements:

```html
<div id="faq0">Section 0: Submitting entries to a new IOCCC</div>
```

We are testing a fix for the top level HTML files.

Run `make gen_top_html` to perform the above and test under macOS.

TODO: Apply this type of fix across the entire web site if all is well.
2024-04-15 17:00:38 -07:00
Cody Boone Ferguson 153b216279 Fix several typos in FAQ 2024-04-14 07:37:37 -07:00
Landon Curt Noll 1c7e42841d Merge pull request #2286 from xexyl/make-compat-faq
Add FAQ 3.19: make(1) compatibility
2024-04-13 17:07:31 -07:00
Landon Curt Noll a2d8249e86 improve the footer of HTML files
We improve the `inc/footer.default.html` file to make
the _Copyright and CC BY-SA 4.0 License_ clear.

We add `license.md` and generate `license.html` (via `make
gen_top_html`) so that key features and terms of the _Copyright and
CC BY-SA 4.0 License_ are accessible.

Add CC BY-SA 4.0 license images into the `png/` directory.

FYI: We use the license to allow the open use of IOCCC entry code,
and at the same time, we help ensure that those working on the IOCCC
have proper Attribution including, of course, the IOCCC winners
themselves!  The _Copyright and CC BY-SA 4.0 License_ help ensure
that everyone may enjoy the IOCCC.

Added '#copyright' to all generated HTML pages so that the
_Copyright and CC BY-SA 4.0 License_ may be reached.

Changed `bin/gen-top-html.sh` VERSION from "1.2.2 2024-03-26"
to "1.2.3 2024-04-12".

Fix `bin/gen-sitemap.sh` to remove requirement of `ioccc.tar.bz2`.

Changed `bin/gen-sitemap.sh` VERSION from "1.3.4 2024-03-27"
to "1.3.5 2024-04-13".

Perform `make www sitemap` to perform the above.

We also give a _hint_ as to the next project.

TODO: Complete that next project we are _hinting_ at.

TODO: Review the work being done by a web designer to see
      how their work might be incorporated into the web site.
2024-04-13 17:01:37 -07:00
Cody Boone Ferguson 1023fe227f Add FAQ 3.19: make(1) compatibility
This FAQ entry explains that the IOCCC only supports GNU make(1)
Makefiles.
2024-04-13 06:49:34 -07:00
Landon Curt Noll 3ddbac9e6b improve how markdown code language is commented
We added a space between the markdown triple code mark
and language that was enclosed in HTML comments.

So a line of the form:

````
```<!---c--->
````

became:

````
``` <!---c--->
````

This was done to **help** some code see that the HTML comment
string was not a markdown code specifier.   Not all code
understands this after this changed.  For example, `pandoc(1)`
still forms HTML classes of the form "&lt;!---c--&gt;"
when it encounters the above mentioned change.

We also fixed a problem with `2019/dogon/README.md` regarding
a markdown code block.

We also fixed a problem with `2020/yang/README.md` regarding
a markdown code block.
2024-04-12 11:45:50 -07:00
Landon Curt Noll c549f6585e add FAQ about feedback, improve contact, update bin/status2html.sh
We added FAQ 0.5 about how to make a suggestion on IOCCC rules, guidelines and tools.

We added a mastodon tag for _contact.html#mastodon_.

We made a minor improvement to bin/status2html.sh about when
the IOCCC is open for submissions.

Changed `bin/status2html.sh` VERSION from "1.1.2 2024-03-26"
to "1.1.3 2024-04-12".

TODO: Complete content that hinted at by what is currently broken links.
      We pushed this change thru on the FAQ now, because we were aware of
      others wishing to submit a FAQ related pull request.
2024-04-12 10:53:17 -07:00
Landon Curt Noll b66c79254a add hack-a-round for language specified markdown code blocks
When language is specified in a markdown code block such as:

````
```c
    printf("Hello, world!\n");
```
````

is used, the resulting HTML as produced by `pandoc(1)` combined
with our revised `ioccc.css` is not intent the code block well.

A temporary "_hack-a-round_" is to turn the "markdown code language
specifier" into an HTML comment.  For example:

````
```<!---c-->
    printf("Hello, world!\n");
```
````

This commits turns off existing markdown code language specifiers
for now, while preserving our ability to restore them in the future
when a better  "_hack-a-round_" to the "markdown code language
specifier" problem is found.

The HTML impact if this "_hack-a-round_" is to produce HTML that
looks like this:

```
<pre class="&lt;!---c--&gt;"><code> .. </code></pre>
```

We might be able to create a complex set of classes for each markdown
code language (there won't be very many) in `ioccc.css`, or we might
find a more general CSS (or maybe `pandoc(1)`?) solution.

For now, this hack-a-round will have to do.
2024-04-04 14:50:38 -07:00
Landon Curt Noll a996f8d2b8 improved indentation and whitespace for markdown code blocks
All code blocks in markdown have been intended by at least 4 spaces.

We add `--tab-stop=8` to all `pandoc(1)` executions in order to set
a better tab stop indentation, especially for tab intended code blocks.

Changed `bin/pandoc-wrapper.sh` VERSION from "1.5.3 2024-03-26"
to "1.6 2024-03-31".

Fixed `1991/brnstnd/sorta.README.md` so that the sorta code
is code blocks.

Removed unneeded paragraph group in copyright in `inc/footer.default.html`.

Fixed excess whitespace after list Author on entry `index.html` page.

Changed `bin/output-index-author.sh` VERSION from "1.5.2 2024-03-26"
to "1.6 2024-03-31".

Performed `make www` to perform the above and test under macOS.

TODO: Fix the problem of the initial line of code being extra intended.
TODO: Fix excess whitespace around code that is inline.
2024-04-01 04:48:48 -07:00
Landon Curt Noll cbc022d864 improve Copyright and CC
The inc/footer.default.html now has a common Copyright and CC BY-SA
4.0 License section for all generated HTML files.

All markdown files have a similar Copyright and CC
at the bottom in the form of an HTML comment.
2024-03-20 00:19:52 -07:00
Landon Curt Noll 78863e5311 improve spacing on some bullet lists in FAQ 2024-03-19 22:47:48 -07:00
Cody Boone Ferguson 0d25351940 Finish editing of FAQ 1.2
This improves the names of links and adds some new links as well. A
point of interest that could easily be missed with a diff is that the
link of Yusuke Endoh was changed from his GitHub account to his
authors.html section. Also, since the first successful pull request to
the winner repo was acknowledged by author (Yusuke Endoh) I added the
author of the first successful pull request to the temp-test-ioccc repo
(as the commit was cited) (and that indeed would be me). It might be
that keeping the GitHub accounts would be better and I can certainly
change them back but it seemed nicer to acknowledge the author entries
as that's the real honour of being a winner.

There were other things besides the above but they were all along the
same lines.
2024-03-19 06:45:25 -07:00
Cody Boone Ferguson 25ccb14461 Fix regexp in faq.md 2024-03-16 08:34:57 -07:00
Landon Curt Noll 1f2920d7ba update FAQs with references to full requests 2024-03-11 09:23:38 -07:00
Landon Curt Noll f482380661 remove XXX from text in faq.md
In several cases where the `faq.md` had **XXX**'s, we replaced the
text with equivalent text for someone to read (such as the **IOCCC
registration procedure** or **IOCCC submit server** is not ready).

In a number of cases, an HTML comment with a **XXX** inside,
was added as an indicator for the need of a future edit.

Added `make sitemap` as an alias for `make gen_sitemap`.

Performed `make gen_top_html sitemap` to do perform the above.
2024-03-10 22:09:46 -07:00
Landon Curt Noll ffb738af07 create new status.json model
Changed the model of `status.json` model.

Updated `status.json` IOCCC_status_version from  "0.2 2023-05-22"
to "1.0 2024-03-09".

Updated FAQ 2.6, improving how IOCCC entries announced.

Moved `bin/ioccc-status.sh` to `tmp/ioccc-status.sh`
now that we have a new status.json model for
which this tool no longer fits (sorry tm Canada 🇨🇦).

Added `status.md` markdown to explain the `status.json` model.

Added `status.html` to both display the contents of `status.json`
and render the contents of `status.md` as HTML.

Added `bin/status2html.sh` to convert `status.json`
into HTML for the `status.html` file.

Added `bin/gen-status.sh` to form `status.json`
and `status.html` files.

Added `make gen_status` to top level Makefile.

Performed `make www` to complete all of the above.
2024-03-10 10:05:08 -07:00
Landon Curt Noll 9843a74862 add terms name to FA6.9 2024-03-08 15:18:22 -08:00
Landon Curt Noll be0a0572da add faq.html#pull_request name for FAQ 6.10 2024-03-08 14:52:59 -08:00
Cody Boone Ferguson 40e3808b78 Minor fixes and updates to FAQ
'FAQ 6.10: How does someone make a change to a file and submit that
change as a GitHub pull request?' has been updated to note that the
authors of winning entries tend to have more deference but that the
judges still have the final say in the matter.

There were some typos (including links) and formatting fixes as well.
2024-03-07 08:54:54 -08:00
Cody Boone Ferguson 605ba1110f Make improvements to FAQ 1.2
This is not completed. I still have to look at the section '2020 Dec 30
thru 202y MMM DD - Work on the temp-test-ioccc GitHub repo' and anything
beyond it.
2024-03-06 07:42:26 -08:00
Landon Curt Noll e1aeac4dae updated FAQ 1.2 with detailed repo history
The "FAQ 1.2: What is the history of the IOCCC web site"
entry with detailed information about GitHub repo history.
2024-03-05 14:45:49 -08:00
Landon Curt Noll 2b92c89be8 fix and improve links within the web site
Entry source is now prog.c for IOCCC years 2014 thru 2020,
or is now dirname.c IOCCC years 1984 thru 2013.

To achieve this state, we renamed the following:

renamed:    2004/hibachi/src/hibachi.c -> 2004/hibachi/hibachi.c
renamed:    2012/omoikane/nyaruko.alt.c -> 2012/omoikane/omoikane.alt.c
renamed:    2012/omoikane/nyaruko.alt2.c -> 2012/omoikane/omoikane.alt2.c
renamed:    2012/omoikane/nyaruko.c -> 2012/omoikane/omoikane.c
renamed:    2012/omoikane/nyaruko.orig.c -> 2012/omoikane/omoikane.orig.c

Modified `bin/subst.entry-index.sh` to add to entry `index.html` file,
links to the `Makefile` and the _C code_ to the top navigation bar.
Changed `bin/subst.entry-index.sh` VERSION from "1.2.2 2024-02-25"
to "1.3 2024-03-02".

Moved printing the Inventory link in the top navigation bar
from `bin/subst.entry-navbar.awk` to `bin/subst.entry-index.sh`.
Changed `bin/subst.entry-navbar.awk` VERSION from "1.0.1 2024-02-23"
to "1.1 2024-03-02".

Moved printing the Inventory link in the top navigation bar
from `bin/subst.year-navbar.awk` to `bin/subst.year-index.sh`.
Changed `bin/subst.year-index.sh` VERSION from "1.0 2024-02-11"
to "1.1 2024-03-02".
Changed `bin/subst.year-navbar.awk` VERSION from "1.0 2024-02-11"
to "1.1 2024-03-02".

Added location names (both default and common) to `author.html`.
Changed `tmp/gen_author_json.sh` VERSION from "1.0 2023-06-06"
to "1.1 2024-03-04".

Added location names (both default and common) to `author.html`.
Changed `bin/gen-authors.sh` VERSION from "1.2 2024-03-09"
to "1.3 2024-03-04".

The manifest and the resulting `.entry.json` files have been changed
for `2004/hibachi` and `2012/omoikane`.

The Makefiles for  `2004/hibachi` and `2012/omoikane` copy the
source file into the "previously used location".  The `make clobber`
rule removes the copied source.  The `.gitignore` files have been
updated accordingly.

Improved how the concept of IOCCC terms _entry_, _author_ and _submission_ are
used in markdown files.

Links to markdown files (files ending in .md) within the repo were
changed to link to HTML files (files ending in .html).  Special cases
where `README.md` became `index.html` were modified accordingly.

Fixed URL for `bugs.html` in Makefile comments.

Fixed name of `bin/sgi.sh` referenced in comments in `.gitignore` files.

Links to locations within the repo are now relative.  For example a
link to `/contact.html` may become `../contact.html' or '../../contact.html`
depending on the directory level of the markdown file.

Nearly all links with absolute URLs under _https://www.ioccc.org_
or `https://ioccc-src.github.io/temp-test-ioccc_ have been changed to
relative paths within the repo.  Some exceptions to this (such as
referring to a GitHub repo) were preserved.

Fixed a number of inside `faq.md` and `bugs.md`.

Added HTML name tags (in the form of an _entry_id_) for each entry
referenced in `bugs.md`.  Fixed links from outside of `bugs.html`
into `bugs.html` accordingly.

Where FAQ entries are referenced, a named tag is used so that if a
FAQ is ever renumbered, links outside of `faq.html` will still work.

Changed the _inventory_order_ of a compressed tarball from _300_
to _100000_.  While this may have been done for the manifest,
this changed had not yet been propagated into the `.entry.json` files.

Links to web sites that were in the for <URL> are now [URL](URL).

Performed `name www` to process all of the above.

Improved format of `authors.html`.  Full names are now bold.
Location codes are now links back into `location.html` and
location names (both default and common) are now italics.
Added _author_handle_ each author.

Changed `bin/gen-authors.sh` VERSION from "1.1 2024-02-25"
to "1.2 2024-03-09".

Improved format of `location.html` as location codes are now bold,
author counts in a given location are now bold, and location names
(both default and common) are now italics.

Changed `bin/gen-location.sh` VERSION from "1.0.1 2024-02-23"
to "1.1 2024-03-04".

Added italic location name after location code in entry
`index.html` files.

Changed `bin/output-index-author.sh` VERSION from "1.4.1 2024-02-23"
to "1.5 2024-03-04".

Added _Location of authors_ to the sidebar as a link to `location.html`.

TODO: While nearly all of the above mentioned changes are likely correct,
      they likely introduced a few errors that need correcting.
2024-03-04 23:45:28 -08:00
Cody Boone Ferguson d40fe40c39 Add FAQ entry about opening pull requests
This used commit afb9e54a4c as an example
(an example commit and pull request was suggested to me by Landon).

Note that I did NOT update the html file as I am not clear how to do
this (for the moment).
2024-03-01 05:59:21 -08:00
Landon Curt Noll 120869a4b2 add FAQ for IOCCC terms Author, Entry, and Submission 2024-02-25 01:17:05 -08:00
Landon Curt Noll ddb6c288b5 update all IOCCC documentation to refer to new IOCCC terms 2024-02-25 00:48:11 -08:00
Landon Curt Noll 86dd9ecac7 fix faq 5.1 directory typo 2024-02-17 21:42:32 -08:00
Cody Boone Ferguson 205fa25ced Change references of many terms to new names
This is a HUGE commit and this task is not done. There are still some
changes that might need to be discussed and since so much is done here I
think it's better to let this go through and then make sure everything
is okay. When the remaining references are discussed they can also be
changed.

I did NOT include changes in the tmp/OLD_manifest directory.

Some of the changes in this commit (it might be exhaustive but it might
not be - not sure):

- In the Makefiles the WINNERS was renamed AUTHORS.
- References to winners.html were changed to authors.html.
- The FAQ named anchor 'fix_a_winner' was renamed 'fix_an_entry'.
- The JSON fields (or whatever they're called) 'winner_id' and
'winner_JSON_format_version' were changed so that 'winner' is 'entry'.
- In scripts for entries 'IOCCC winner' was changed to 'IOCCC entry'.
- 'winners_text' is now 'entries_text'. It might be better to be
'entry_text' as it's per entry but this was not noticed at first. Since
this is easy to fix I am holding off on this for the meantime.
- The script tmp/update-manifest.sh now has the commit log messages
changed to the correct terms as well.

The index.html files were updated as well with any of the above
changes.

There are some references that should NOT be updated. Two examples
caught (and maybe more have slipped through that will have to be changed
back): in 1984/anonymous/README.md the author wrote back to Landon after
being told about the famous tattoo and they used the words:

    .. my entry will be the first IOCCC winner ..

but since this comes from the author it should remain so.

The other one is that winners.html should still refer to winners.html as
it informs people that it's been moved to authors.html (it does redirect
too but even so if it was changed it would defeat the purpose of the
message).

With paths like authors.html I tried to copy paste so that hopefully
there are no typos. It is possible that I did not end up doing this with
all but these can be fixed when discovered.
2024-02-13 07:31:36 -08:00
Landon Curt Noll 1c258e3df4 add FAQ 3.18 on how to compile and install OpenGL
Added FAQ 3.18 - How do I compile and install OpenGL for entries
that require it?

Use faq.md#OpenGL to access this FAQ entry.
2024-02-13 04:22:20 -08:00