17 Commits
Author SHA1 Message Date
Landon Curt Noll f29b37e49a improve HTML menus, add social.html, prep for IOCCC28 winners
Prepare for the winners of **IOCCC28**.

> However these are not the 2024 droids you are looking for.  :-)

The HTML menu (both JavaScript and non-JavaScript) has been updated.

The `Status -> Rules and guidelines' have been replaced with two
separate menus `Status -> IOCCC rules` and `Status -> IOCCC guidelines`.

Added a new top level `social.html` page: built from a new `social.md`.

Sorted rules for building specific web pages in the top level `Makefile`.
Added `make social` to make the `social.html` page from `social.md`.

The `bin/gen-top-html.sh` now is able to process a argument of **social**
to process the new top level `social.html` page.

Changed `bin/gen-top-html.sh` VERSION from "2.0.0 2025-03-13"
to "2.0.1 2025-07-25".

Below `About -> Home page` a new `About -> IOCCC social media` menu item
as added.

Because the menu change touched every HTML file, we changed the general
copyright date range for HTML files from "1984-2024" to "1984-2025"
due to the extensive changes made for **IOCCC28**.

Those markdown files that were modified in 2025 had their copyright date
range also changed from "1984-2024" to "1984-2025".

Rebuilt tarballs and sitemap due to the extensive HTML rebuilding.

Ran `make update` to perform the above.
2025-07-26 13:06:29 -07:00
Landon Curt Noll 3106998954 allow for year level archive of rules and guidelines
Adjusted `bin/md2html.cfg` to allow for the creation of year level
archive of the rules and guidelines that were in effect when the given
year's content opened for submissions.

We improved `bin/gen-year-index.sh` so that if there exists
a `YYYY/rules.md` rules archive, then `YYYY/rules.html`
will be created.

We improved `bin/gen-year-index.sh` so that if there exists
a `YYYY/guidelines.md` rules archive, then `YYYY/guidelines.html`
will be created.

Changed `bin/gen-year-index.sh` VERSION from "2.0.0 2025-03-13"
to "2.1.0 2025-07-05".

Adjusted `next/rules.md` and `next/guidelines.md` so that when they are
copied as archived copies of rules and guidelines under a YYYY directory,
the internal links do not break.  There are **NO** changes to the readable
contents of the rules and guidelines, only some changes to a few internal links.

Updated `1992/buzzard.2/index.html, `1993/rince/index.html`, and
`2012/omoikane/index.html that were modified by recent commits.

Rebuild sitemap due to the changes above.

Ran `make www` to test and perform the above.
2025-07-05 21:24:13 -07:00
Cody Boone Ferguson 81d225f439 Change how example remarks is managed
The file next/remarks.example.md has been renamed next/remarks.md.

From this file a new html file, next/remarks.html, is generated. The
first part of the instructions say to download the markdown file and
copy it to your submission's directory.

The rest is mostly the same but this way one can look at the website and
also be aware of the file (and it'll be linked to in the rules and/or
guidelines as well).

This required updating bin/gen-top-html.sh an bin/md2html.cfg and the
Makefile was updated too (with a typo fix also).
2025-03-04 05:25:25 -08:00
Landon Curt Noll 11dfe51c6c move IOCCC Quick Start Guide
Created `quick-start.md` to hold the FAQ 0.0 content.

Used `sgit(1)` to change:

* faq.html#enter ==> quick-start.html#enter
* faq.html#enter_questions ==> quick-start.html#enter_questions
* faq.html#step_0 ==> quick-start.html#step_0
* faq.html#step_1 ==> quick-start.html#step_1
* faq.html#step_2 ==> quick-start.html#step_2
* faq.html#register ==> quick-start.html#register
* faq.html#step_3 ==> quick-start.html#step_3
* faq.html#step_4 ==> quick-start.html#step_4
* faq.html#step_5 ==> quick-start.html#step_5
* faq.html#step_6 ==> quick-start.html#step_6
* faq.html#step_7 ==> quick-start.html#step_7
* faq.html#step_submit ==> quick-start.html#step_submit

Via:

```sh
sgit -e 's/faq\.html#enter/quick-start.html#enter/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#enter_questions/quick-start.html#enter_questions/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_0/quick-start.html#step_0/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_1/quick-start.html#step_1/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_2/quick-start.html#step_2/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#register/quick-start.html#register/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_3/quick-start.html#step_3/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_4/quick-start.html#step_4/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_5/quick-start.html#step_5/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_6/quick-start.html#step_6/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_7/quick-start.html#step_7/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_submit/quick-start.html#step_submit/g' '*.md' '*.hdr' 'inc/*.html'
```

The former FAQ 0.0 section in `faq.html` now just refers to `quick-start.html`.

Modified menu and non-JS menu so that "Enter the IOCCC" refers to `quick-start.html`.

Changed `bin/gen-top-html.sh` VERSION from "1.4.10 2024-11-23"
to "1.4.11 2025-01-09".

Performed `make www` on macOS to complete the above.
2025-01-09 23:11:43 -08:00
Landon Curt Noll d63065caf6 complete update started with commit 2562ff98ff 2024-12-27 00:14:20 -08:00
Landon Curt Noll 608c77e9f3 add next/submit.html and improve FAQ and other refs to entering the IOCCC
Added a new `next/submit.html` to move the "how to submit" form "in-line"
of the top FAQ entry into a new page managed by `next/submit.md`.
Thus, `next/submit.html` is a parallel to `next/register.html`
and `next/submit.md` is a parallel to `next/register.md`.

Changed the FAQ "faq.html#submit" and into "faq.html#enter".

Added individual tags for the steps in FAQ0.0.

Moved "faq.html#register" down to FAQ 0.0 step 2.

Added "faq.html#submit" for FAQ 0.0 step 5,
however elsewhere often "next/submit.html" is used.

Changed references for "faq.html#upload" to "next/submit.html".

We made a number of changes to the following markdown files to reflect the above:

- `about.md`
- `faq.md`
- `index.md`
- `markdown.md`
- `next/README.md`
- `next/README.md`
- `next/guidelines.md`
- `next/register.md`
- `next/rules.md`
- `nojs-menu.md`
- `status.md`

as well as these files:

- `bin/gen-top-html.sh`
- `bin/md2html.cfg`

and added:

- `next/submit.html`
- `next/submit.md`

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

TODO: Add images about the mailing list to `next/register.md`.  See the line:

```
XXX - **put images and other details about joining the mailing list here** - XXX
```
2024-12-24 16:26:29 -08:00
Landon Curt Noll edf8c1bdcc add next/register.html page, improve bin/gen-status.sh
Added a new `next/register.html` that is required by the mailing list server.
The `next/register.md` still contains a big **XXX - put more data here - XXX**
as a placeholder for information about the mailing list registration process.

Improved the status text for `faq.html`, `next/index.html` and `status.html`
via `faq.md`, `next/README.md` and `status.md`.  We also removed the
excessive links to IOCCC and instead use the term "contest" where applicable.

IMPORTANT CHANGE: Registration be available when the contest is both pending and open.

We made a number of changes to `faq.md`, `next/README.md` in an attempt to
reflect the above.

Changed `bin/gen-status.sh` VERSION from "1.7 2024-09-23"
to "1.8 2024-11-23".

Changed `bin/gen-top-html.sh` VERSION from "1.4.9 2024-08-11"
to "1.4.10 2024-11-23".

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

TODO: Change **XXX - put more data here - XXX** in `next/register.md` for information
      about how to join the mailing list.
2024-12-23 18:17:24 -08:00
Cody Boone Ferguson 75c89bd544 Make authorship comments in bin/ tools consistent 2024-10-25 06:41:45 -07:00
Cody Boone Ferguson 89af774f84 Typo fixes
Typos were fixed in bin/md2html.cfg, bin/subst.default.sh,
nojs-menu.html and nojs-menu.md.

The nojs-menu.html now links to bin/index.html and inc/index.html but
the rest of the html files for now do not. It seems like it might be
good if they do, at least bin/index.html, but if that is decided against
this can be rolled back instead.
2024-10-24 10:51:39 -07:00
Landon Curt Noll 0fa01fd744 add title and abstract to .entry.json and index.html files
We add an initial "_title_" and "_abstract_" to all entry `.entry.json` files.

The `bin/csv2entry.sh` tool reads the `summary.csv` file and
loads the "_title_" and "_abstract_" to entry `.entry.json` files.

Changed `bin/csv2entry.sh` VERSION from "1.3 2024-09-23"
to "1.4 2024-09-27".

Perform `make csv2entry` to perform the above and test under macOS.

The `bin/cvt-submission.sh` tool adds "_title_" and "_abstract_" to the
.entry.json based on the `.info.json` file.

Changed `bin/cvt-submission.sh` VERSION from "1.2 2024-09-23"
to "1.3 2024-09-27".

The `bin/entry2csv.sh` tool forms the `summary.csv` file
based on the "_title_" and "_abstract_" fields found in .entry.json files.

Changed `bin/entry2csv.sh` VERSION from "1.3 2024-09-23"
to "1.4 2024-09-27".

Perform `make entry2csv` to perform the above and test under macOS.

Added `-H` and `header=with-header-3` to the `bin/md2html.cfg`
for the configuration entry for `[12][0-9][0-9][0-9]/*/README.md`.

Changed `bin/md2html.sh` VERSION from "1.6 2024-08-17"
to "1.7 2024-09-27".

All entry `index.html` files now list the "_abstract_" in a new
`<h3>abstract</h3>` header.

Changed `bin/subst.entry-index.sh` VERSION from "1.6 2024-09-23"
to "1.7 2024-09-27".

Removed `summary.csv`.

Added `summary.csv` and `summary.numbers` to `.gitignore`.
Sorted the result with `bin/sgi.sh`.

Perform `make quick_www` to perform the above and test under macOS.

Perform `make www` to perform the above and test under macOS.
2024-09-27 23:40:45 -07:00
Landon Curt Noll 783d39b24f add missing author/index.html
We changed `author/README.md` to refer to FAQs instead
of trying to duplicate FAQ information.

Added `author/README.md` to `bin/md2html.cfg`.

Changed `bin/gen-top-html.sh` VERSION from "1.4.8 2024-08-05"
to "1.4.9 2024-08-11".

Performed `make gen_top_html` to accomplish the above and to test under macOS.
2024-08-11 23:21:13 -07:00
Landon Curt Noll 31868158ea improve the result of pr 2570
We improve the language in `SECURITY.md` and the resulting
`SECURITY.html` page, and add an important disclaimer.  We also add
that same disclaimer to the bottom of the of the main `index.html`
we page (via `index.md`).
2024-07-15 14:25:04 -07:00
Cody Boone Ferguson 641d70df21 Typo fix in SECURITY.md
Also removed what seems to be unnecessary quotes, much along the lines
in some FAQ links (that will be having the quotes removed).

Added SECURITY.md to bin/md2html.cfg and updated bin/gen-top-html.sh to
build SECURITY.html. The configuration can be improved for keywords and
other things and the file is not linked into the website either but
presumably it should be.
2024-07-14 13:50:46 -07:00
Landon Curt Noll affbd30553 fix 1992/westley/README.md, warn about TAB intending in markdown.md
One must **NOT** use ASCII TAB characters to intent text.  Down the TAB-ed
road is nothing but trouble!  There are _quasi-solutions_, however those
have side effects that lead to a different set of problems.

The `markdown.md` was updated to ask that text not be intended with ASCII tabs.

See [Please do NOT use ASCII tabs to indent
text](https://ioccc-src.github.io/temp-test-ioccc/markdown.html#markdown.html#please-do-not-specify-a-language-for-a-code-block).

We discovered this awhile ago and fixed it in markdown files.  Sorry
(tm Canada 🇨🇦), we forgot to mention this this in `markdown.md`.

BTW: It took some **deep magic** to be able to show an HTML comment
after a starting fenced markdown code block!  See the **NO_COMMENT=**
line in `bin/md2html.cfg`.  :-)

TODO: Stamp out indenting TABs in markdown files, especially in code blocks.

TODO: Consider a rule to detect problematic ASCII TAB intendation
      within makrkdown files.
2024-06-22 21:38:03 -07:00
Cody Boone Ferguson 826a6eb01a Typo fix menu item for location of authors
It should be 'Location of winning authors' (as it is now) but by mistake
there was an extra space ('Location of winning  authors'). Obviously
this is a huge commit as every html file with a menu (almost all) had to
be updated.
2024-06-17 05:57:52 -07:00
Cody Boone Ferguson ddd397a563 Improve menu and link title and consistency
A few page names were changed and menu link (titles) were changed too.
By page names it means either DESCRIPTION or HEADER_2 in
bin/md2html.cfg. Although it looks better and is more consistent, there
might be one or two that can be further improved.

Naturally every html file that is markdown based was updated.
2024-06-16 07:44:54 -07:00
Cody Boone Ferguson c60fa3ce7e Move inc/md2html.cfg to bin/
This is a very large commit not only because I forgot to run make www
after updating the menus but I also forgot to do that after the update
to some of the award titles (only quick-readme2index.sh was used).

There is a typo fix in bin/README.md.

This commit does mean that md2html.cfg has to be added to bin/README.md
but that can be done later.

The steps run to verify this works okay:

	make www
	git status
	git diff
	git add -u
	make update
	git status
	git restore $(git check)

The last is important as it is not time for make update. 'git check' is
an alias:

	git diff --name-only
2024-06-15 12:40:42 -07:00