Theo Todman's Web Page - Notes Pages
Website Generator Documentation - Reference Functions
(Work In Progress: output at 01/02/2019 14:11:50)
- This document covers the following functions invoked during the formatting of web-pages in order to provide links between the various object-pages on my website:-
- Authors: Reference_Author.
- Books: Reference_Books.
- Footnotes: Reference_FootNotes, NoteFootnotes.
- Notes / Notes_Archive: Reference_Notes.
- Note Links: Reference_Note_Links.
- Papers: Reference_Papers.
- References: Reference_Reference.
- WebRefs: Reference_Webrefs.
- To see the Code, click on the procedure names above.
- The reference tags are in +χχ+ format.
- The values of χ that have been “bagged” are: A, B, C, L, N, P, Q, R, T, W and X.
- Some of the above functions are straightforward and require little comment. The default below will be “no comment”.
- Others are more complex and require explanation – if only so I know how they work and can correct fudges and mistakes that have arisen over time.
- Yet others are rarely used, and it’s useful to know that they exist!
- All these functions, with one exception (WebRefs, which are documented elsewhere1), provide links within my own website.
- One of the difficulties is to determine where in the various directory hierarchies the pages referenced are.
- A difficulty used to be that documenting these references involved accidentally using (rather than simply mentioning) the referencing systems. Thankfully – as a result of producing this Note – this difficulty is now fixed2!
- Documenter References
- These cover the referencing for Code, Tables & Queries.
- The details of the Documenter itself will be covered by the documentation for the Code Documenter3. However, links into the Documenter web-pages are not strictly part of the Documenter itself, so will be covered here.
- These links ought to be capable of being invoked from any object and not just from the documentation itself (ie. Notes) as here. Unfortunately, this is not the case4, but would only cause a problem if links to the code, etc., were attempted from Books or Papers (unlikely). An issue might arise if a Paper had an embedded Note, but this is also unlikely.
- The referencing convention is +CC+, +QQ+ & +TT+, with the code, query or table name inserted between the convention-letters.
- It looks like +CC+ is used for both bridge and non-bridge code, so I doubt it can work for bridge-code.
- Authors: The referencing convention is +AA+, with the author’s name in “Todman (Theo)” format for Theo Todman. Display unpacks it to read like a name (as indicated) – even if the author is not found in the database – when there’s no link, of course.
- Books: The referencing convention is +BB+, with the Book ID inserted between the convention-letters.
- The referencing convention is ++FN++, with the footnote text inserted between the …
- Footnotes were originally restricted to Notes and Archived Notes (using Notes_Text_Format and NoteFootnotes), but can now be used for Book and Paper Abstracts, and Author Narratives (Reference_FootNotes).
- They appear at the bottom of documents, with a link back to the point of reference.
- If two footnotes have identical text, the footnote only appear once on the web-page, though necessarily has to appear twice in the database text.
- Note Links:
- The referencing convention is +LL+, with the Note ID inserted between the convention-letters.
- This results from the Auto-Reference Notes5 function.
- A side-effect of the above process is that tags “+χχ+” but with “X” instead of “χ”. The “+χχ+” are introduced to stop a particular instance of a keyword being automatically linked. These tags are then removed before any web-page is output, which is why I can’t display them here!
- Notes / Notes_Archive:
- This is difficult to document, but doesn’t use the “+χχ+” format, so can be ignored here.
- The exception is that Note hyperlinks within Footnotes use a “+NN+” tag with the Note ID inserted between the convention-letters.
- The referencing convention is +RR+, with the Reference ID inserted between the convention-letters.
- This allows links to particular places within Notes. There are two parts to the process:-
- A label in the +RR+ format is placed in the Note in the place where the hyperlink is to be to, with the Link ID inserted between the convention-letters.
- Then, the HTML “#” convention is used in the Note (or other object) from which the hyperlink takes place. The Link ID is added to the Note ID, separated by the “#”.
- Papers: The referencing convention is +PP+, with the Paper ID inserted between the convention-letters.
- WebRefs: The referencing convention is +WW+, with the WebRef ID inserted between the convention-letters. The processing is described in the following Note6.
In-Page Footnotes:Footnote 2:
- There’s an exception for Notes and Archived Notes, and – partially – for Footnotes.
- Documenting these processes involves mentioning 2x+ and 4x+, which currently causes program loops.
- Actually, I’m not sure whether this caveat is true anymore – it may well all work.
- I need to check this out sometime!
Summary of Note Links from this Page
To access information, click on one of the links in the table above.
Text Colour Conventions
- Black: Printable Text by me; © Theo Todman, 2019
- Blue: Text by me; © Theo Todman, 2019