Commit Graph
11 Commits
Author SHA1 Message Date
Cody Boone Ferguson 3deb7ae603 Improve markdown guidelines wording
Amongst the changes here is that we do not need to have the hex or html
code (numbers) for open and close parentheses (in links) as there are
names. '(' is & followed by lpar; and the ')' is the same but 'rpar;'
instead. This makes it easier to remember and type and it generates the
same html as well (they are all valid). Now the markdown files are
consistent in this (in some cases hex was used and in others the html
code).

Although many markdown files were updated no html files needed to be
updated as it generates the same html. Even so I ran the appropriate
rules to do so just to verify this.
2024-07-31 10:44:10 -07:00
Cody Boone Ferguson 009e1b7522 Link in SECURITY.html to all web pages
The location of the link is in the About menu under the 'Contacting the
IOCCC' and above 'Thanks for the help'. At first I had it at the very
bottom, under 'IOCCC markdown guidelines', but it seemed better to have
it closer to contacting the IOCCC. This is the same location in the no
JavaScript menu (which, for those who do not know or forget, is not a
requirement except for some screen sizes).

The top level Makefile has a new 'security' rule. Updated make help.

Typo fixes in make help.

SECURITY.html has had a few updates as well: change the wording of entry
code is unsupported (it now says 'ALL CODE IN ALL IOCCC ENTRIES IS
UNSUPPORTED!!') and it now links to the mkiocccentry repo and how to
report a possible security vulnerability in that repo; as that IS
supported - and since there was reference to discussing security
concerns is in SECURITY.html - even though the entries will not receive
security updates - it seemed a good idea to have a link to report such
security issues in the mkiocccentry repo. Perhaps the FAQ needs to be
updated for this too.
2024-07-15 08:55:54 -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
Cody Boone Ferguson a98d8397a4 Fix consistency in menus and pages
In some pages at the top it had 'and' but in the menu it had instead a
'&'. The menus (JavaScript and otherwise) now has 'and' to match the
pages. The file nojs-menu.html has been checked for broken links and
indeed one at least was fixed. Very few top level html files need to be
checked now. Some that are entirely generated should be okay but links
will still be checked to be sure.

Some cases of '(Mis)features' from the previous commit were also
corrected to '(mis)features' as this is also part of menu and page
consistency.

The files markdown.{md,html} have had the menus updated too but there
are some other changes that were works in progress. This file is not
thus completed but will be sometime soon.
2024-06-15 11:11:37 -07:00
Landon Curt Noll 6e698b238a changed web site to website 2024-06-07 02:10:24 -07:00
Landon Curt Noll ce662db192 add IOCCC markdown to the About menu 2024-05-28 15:22:22 -07:00
Landon Curt Noll 1d5fcc04a7 fix makrdown links to HTML files that use a %%TOKEN%% 2024-05-04 16:56:51 -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
Landon Curt Noll b84f8cbe28 improve topbar
The icons used to show the menu open (`png/hamburger-icon-open.png`)
and closed (`png/hamburger-icon-closed.png`) have been added.

Changed `inc/topbar.default.html` to use the png icons instead
of a svg file.

A new page `nojs-menu.html` has been added for when
JavaScript is disabled.

Changed `bin/gen-top-html.sh` VERSION from to "1.4.4 2024-04-21"
to "1.4.5 2024-04-23".

Sorted top sections in `inc/md2html.cfg` and added
a section for `nojs-menu.md`.

Fixed `ioccc.css` so that the topbar and related pulldown
menus had the correct background colour.

Ran `make www` to perform the above.

TODO: Detect when JavaScript is disabled and display:

		Please
		Enable
	      JavaScript

      As a link to the new `nojs-menu.html` page.

TODO: Fix a problem on wide screens where some of
      the righthand edge pulldown menus are cutoff.

TODO: Fix the 5 HTML 5 errors introduced by the topbar code.
2024-04-23 23:47:03 -07:00