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

fix and improve links within the web site

Browse Source 
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.
This commit is contained in:
Landon Curt Noll committed 2024-03-04 23:45:28 -08:00
1 parent 91c55a20fd
commit 2b92c89be8
1811 files changed
+11313 -9962
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

bin/README.md
+33 -27
View File
@@ -1,11 +1,11 @@
# bin
The directory holds [bin](README.md) directory
The directory holds [bin](index.html) directory
holds tools that build files, such as HTML content, for the
[official IOCCC web site](https://www.ioccc.org).
For HTML content, the [bin](README.md) directory tools
makes use of HTML fragments from the [inc](../inc/README.md) directory
For HTML content, the [bin](index.html) directory tools
makes use of HTML fragments from the [inc](../inc/index.html) directory
as well as various JSON files and other content from the
[IOCCC GitHub repo](https://github.com/ioccc-src/temp-test-ioccc).
@@ -93,7 +93,7 @@ bin/gen-location.sh -v 1
### [gen-other-html.sh](gen-other-html.sh)
Generate entry HTML files from markdown other than README.md to index.html HTML files.
Generate entry HTML files from markdown other than index.html to index.html HTML files.
Usage:
@@ -124,12 +124,18 @@ bin/gen-top-html.sh -v 1
Examples of top level HTML pages built by this tool include:
- [CODE_OF_CONDUCT.html](CODE_OF_CONDUCT.html)
- [README.html](README.html)
- [bugs.html](bugs.html)
- [contact.html](contact.html)
- [faq.html](faq.html)
- [thanks-for-help.html](thanks-for-help.html)
- [CODE_OF_CONDUCT.html](../CODE_OF_CONDUCT.html)
- [archive/historic/index.html](../archive/historic/index.html)
- [bin/index.html](../bin/index.html)
- [bugs.html](../bugs.html)
- [contact.html](../contact.html)
- [faq.html](../faq.html)
- [inc/index.html](../inc/index.html)
- [index.html](../index.html)
- [thanks-for-help.html](../thanks-for-help.html)
- [judges.html](../judges.html)
- [news.html](../news.html)
- [thanks-for-help.html](../thanks-for-help.html)
### [gen-year-index.sh](gen-year-index.sh)
@@ -156,7 +162,7 @@ bin/gen-years.sh -v 1
### [ioccc-status.sh](ioccc-status)
Updates the [status.json](/status.json) file.
Updates the [status.json](../status.json) file.
### [manifest.entry.json.awk](manifest.entry.json.awk)
@@ -168,7 +174,7 @@ Output manifest table from a entry .entry.json file.
This is the primary tool that forms IOCCC generated HTML content from
markdown files (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the [inc](/inc) directory.
markdown files) and HTML fragments from the [inc](../inc/index.html) directory.
The [../inc/md2html.cfg](../inc/md2html.cfg) configuration file is
used by [md2html.sh](md2html.sh) to drive the generation process.
@@ -198,11 +204,11 @@ Wrapper tool to run pandoc.
Runs [readme2index.sh](readme2index.sh) if the entry directory
does not have a non-empty `index.hmtl` file, or if either
`.entry.json` or `README.md` is newer than the `index.hmtl` file.
`.entry.json` or `index.html` is newer than the `index.hmtl` file.
This is useful when only a few entries have been
modified (resulting in an updated `.entry.json` file)
or if the `README.md` of a few entries have been changed.
or if the `index.html` of a few entries have been changed.
While the [readme2index.sh](readme2index.sh) take a few
seconds to run, when applied to 300+ entries,
@@ -218,7 +224,7 @@ bin/all-run.sh -v 3 bin/quick-readme2index.sh -v 1
**NOTE**: This command assumes that the relative
modification times for `index.hmtl`, .entry.json`,
and `README.md` are correct. If in doubt, use:
and `index.html` are correct. If in doubt, use:
```sh
bin/all-run.sh -v 3 bin/readme2index.sh -v 1
@@ -227,7 +233,7 @@ bin/all-run.sh -v 3 bin/readme2index.sh -v 1
### [readme2index.sh](readme2index.sh)
Convert a entry README.md into entry directory index.html.
Convert a entry index.html into entry directory index.html.
### [sgi.sh](sgi.sh)
@@ -337,15 +343,15 @@ site](https://www.ioccc.org).
Nearly all IOCCC related HTML pages are built from markdown files,
from either permanent markdown files or temporary generated markdown files,
as well as HTML fragments from the [inc](../inc/README.md) directory.
as well as HTML fragments from the [inc](../inc/index.html) directory.
Most HTML content is built from permanant markdown files, such as a `README.md`
Most HTML content is built from permanant markdown files, such as a `index.html`
markdown file found in each entry directory. Some HTML content are generated
from temporary markdown files. These temporary markdown files are produced by
tools in the [bin](README.md) directory and exist only while the tool is running.
tools in the [bin](index.html) directory and exist only while the tool is running.
In addition to converting markdown to HTML, the canonical way that HTML content is
built uses, by default, files from the [inc](../inc/README.md) directory, of the form:
built uses, by default, files from the [inc](../inc/index.html) directory, of the form:
```
*.default.html
@@ -522,17 +528,17 @@ and except 'after tool' output), or command will exit non-zero, unless -S is giv
only a warning about un-substituted tokens will be written to stderr.
The command line of tools in the [bin](README.md) directory,
The command line of tools in the [bin](index.html) directory,
and perhaps modified via [md2html config file](../inc/md2html.cfg) file may change
to using a different filename for a given phase.
For example when forming the HTML from `2020/ferguson2/chocolate-cake.md`,
For example when forming the HTML from `2020/ferguson2/chocolate-cake.html`,
a different "topnav" navigation bar is needed. So instead of the
usual top navigation bar that normally directs people to the previous
entry for the year, or go up to the year page, or to the next entry
for the year, a top navigation bar to just go up to the entry's
main page is needed. A line in the [md2html config file](../inc/md2html.cfg) file
that refers to `2020/ferguson1/chocolate-cake.md` may specify use
that refers to `2020/ferguson1/chocolate-cake.html` may specify use
of `topnav.up2index.html` instead of using the `topnav.default.html` default.
The HTML phase may be skipped resulting in no HTML output during a given phase.
@@ -551,7 +557,7 @@ on the [official IOCCC web site](https://www.ioccc.org).
These files are used to form **MOST** of the HTML content
on the [experimental web site](https://ioccc-src.github.io/temp-test-ioccc/).
... and in particular files under [inc](../inc/README.md) that are of the form (called default HTML files) ...:
... and in particular files under [inc](../inc/index.html) that are of the form (called default HTML files) ...:
```
*.default.html
@@ -567,7 +573,7 @@ not impact **MOST** of the HTML content.
# Why do we do not use certain well-known HTML technologies
You may wonder why we need these files in the first place.
You may wonder why we even need the tools in the [bin](README.md) directory
You may wonder why we even need the tools in the [bin](index.html) directory
when there other solutions available to form web pages.
@@ -724,7 +730,7 @@ The latter form is in case there are more than one anonymous author in a given
year.
NOTE: even if the directory name is not `anonymous` the above rules apply as in
in the case of [2005/anon](/2005/anon/anon.c).
in the case of [2005/anon](../2005/anon/anon.c).
Anonymous `author_handle`'s match this regexp:
@@ -775,7 +781,7 @@ Each `year` will have a file directory under it named:
```
The contents of the `.year` file is the year string of the directory. For
instance, [2020/.year](/2020/.year) has the string: `2020`.
instance, [2020/.year](,,/2020/.year) has the string: `2020`.
## `dir`