Miscellaneous utility functions for producing index content.

• §1. Header
• §2. Links to source
• §3. Links to detail pages
• §4. "See below" links
• §5. "Show extra" links, and also a spacer of equivalent width
• §7. "Deprecation" icons
• §8. Miscellaneous utilities

§1. Header.

void Index::banner_line?Usage of Index::banner_line:
The Periodic Table - §2.5
Grouped Element - §1(OUTPUT_STREAM, index_page *page, int N, text_stream *sym,
    text_stream *name, text_stream *exp, char *link) {
    HTML_OPEN_WITH("table", "cellspacing=\"3\" border=\"0\" style=\"background:#eeeeee;\"");
    HTML_OPEN("tr");
    Write the banner mini-element-box1.1;
    Write the row titling element1.2;
    HTML_CLOSE("tr");
    HTML_CLOSE("table");
    WRITE("\n");
}

§1.1. Write the banner mini-element-box1.1 =

    int ref = (page)?(page->allocation_id+1):1;
    HTML_OPEN_WITH("td", "valign=\"top\" align=\"left\"");
    HTML_OPEN_WITH("div", "id=\"minibox%d_%d\" class=\"smallbox\"", ref, N);
    TEMPORARY_TEXT(dets)
    WRITE_TO(dets, "class=\"symbol\" title=\"%S\" ", name);
    if (link) WRITE_TO(dets, "href=\"%s\"", link);
    else WRITE_TO(dets, "href=\"#\" onclick=\"click_element_box('segment%d'); return false;\"", N);
    HTML_OPEN_WITH("a", "%S", dets);
    DISCARD_TEXT(dets)
    WRITE("%S", sym);
    HTML_CLOSE("a");
    HTML_OPEN_WITH("div", "class=\"indexno\"");
    WRITE("%d\n", N);
    HTML_CLOSE("div");
    HTML_CLOSE("div");
    HTML_CLOSE("td");

• This code is used in §1.

§1.2. Write the row titling element1.2 =

    HTML_OPEN_WITH("td", "style=\"width:100%%;\" align=\"left\" valign=\"top\"");
    HTML_OPEN_WITH("p", "style=\"margin-top:0px;padding-top:0px;"
        "margin-bottom:0px;padding-bottom:0px;line-height:150%%;\"");
    WRITE("<b>%S</b> &mdash; \n", name);
    Index::explain(OUT, exp);
    HTML_CLOSE("p");
    HTML_CLOSE("td");

• This code is used in §1.

§2. Links to source. When index files need to reference source text material, they normally do so by means of orange back-arrow icons which are linked to positions in the source as typed by the user. But source text also comes from extensions. We don't want to provide source links to those, because they can't easily be opened in the Inform application (on some platforms, anyway), and in any case, can't easily be modified (or should not be, anyway). Instead, we produce links.

So, then, source links are omitted if the reference is to a location in the Standard Rules; if it is to an extension other than that, the link is made to the documentation for the extension; and otherwise we make a link to the source text in the application.

void Index::link?Usage of Index::link:
Index Rules - §1.1, §4.5, §4.7, §6, §8, §8.1
Lexicon - §7.2
Arithmetic Element - §1.3
Behaviour Element - §1
Chart Element - §7, §8.4, §9.1
Commands Element - §4
Contents Element - §1.1.1, §2.1
Events Element - §1.1, §1.2
Figures Element - §1.1, §1.2, §1.3
Grouped Element - §1, §1.1, §2
Innards Element - §2.3
Map Element - §2.5, §2.8, §3, §7
Plot Element - §1.3.1.1, §1.3.1.4.2, §1.3.1.4.3
Relations Element - §1
Tables Element - §1.3, §1.3.1
Tokens Element - §1
Values Element - §1.1.2, §1.2
Verbs Element - §1
Spatial Map - §42
Render HTML Map - §12(OUTPUT_STREAM, int wn) {
    Index::link_to_location(OUT, Lexer::word_location(wn), TRUE);
}

void Index::link_location(OUTPUT_STREAM, source_location sl) {
    Index::link_to_location(OUT, sl, TRUE);
}

void Index::link_to(OUTPUT_STREAM, int wn, int nonbreaking_space) {
    Index::link_to_location(OUT, Lexer::word_location(wn), nonbreaking_space);
}

void Index::link_to_location(OUTPUT_STREAM, source_location sl, int nonbreaking_space) {
    #ifdef SUPERVISOR_MODULE
    inform_extension *E = Extensions::corresponding_to(sl.file_of_origin);
    if (E) {
        if (Extensions::is_standard(E) == FALSE) {
            if (nonbreaking_space) WRITE(" "); else WRITE(" ");
            Works::begin_extension_link(OUT, E->as_copy->edition->work, NULL);
            HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/Revealext.png");
            Works::end_extension_link(OUT, E->as_copy->edition->work);
        }
        return;
    }
    #endif
    SourceLinks::link(OUT, sl, nonbreaking_space);
}

§3. Links to detail pages. The "Beneath" icon is used for links to details pages seen as beneath the current index page: for instance, for the link from the Actions page to the page about the taking action.

void Index::detail_link?Usage of Index::detail_link:
Alphabetic Element - §1
Commands Element - §4
Grouped Element - §1(OUTPUT_STREAM, char *stub, int sub, int down) {
    WRITE(" ");
    HTML_OPEN_WITH("a", "href=%s%d_%s.html", (down)?"Details/":"", sub, stub);
    HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/Beneath.png");
    HTML_CLOSE("a");
}

§4. "See below" links. These are the grey magnifying glass icons. The links are done by internal href links to anchors lower down the same HTML page. These can be identified either by number, or by name: whichever is more convenient for the indexing code.

void Index::below_link?Usage of Index::below_link:
§10
Chart Element - §8.4(OUTPUT_STREAM, text_stream *p) {
    WRITE(" ");
    HTML_OPEN_WITH("a", "href=#%S", p);
    HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/Below.png");
    HTML_CLOSE("a");
}

void Index::anchor?Usage of Index::anchor:
Card Element - §1
Chart Element - §8.1
Commands Element - §4
Innards Element - §1, §1.1
Lexicon Element - §1
Map Element - §1, §2.1
Plot Element - §1.3
Rules for Scenes Element - §1
Values Element - §1.1
Render HTML Map - §8(OUTPUT_STREAM, text_stream *p) {
    HTML_OPEN_WITH("a", "name=%S", p); HTML_CLOSE("a");
}

void Index::below_link_numbered?Usage of Index::below_link_numbered:
Lexicon - §7.2
Chart Element - §5
Phrasebook Element - §1
Plot Element - §2.2(OUTPUT_STREAM, int n) {
    WRITE(" ");
    HTML_OPEN_WITH("a", "href=#A%d", n);
    HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/Below.png");
    HTML_CLOSE("a");
}

void Index::anchor_numbered?Usage of Index::anchor_numbered:
Chart Element - §2.7
Phrasebook Element - §1
Plot Element - §1.3.1.1
Verbs Element - §1(OUTPUT_STREAM, int n) {
    HTML_OPEN_WITH("a", "name=A%d", n); HTML_CLOSE("a");
}

§5. "Show extra" links, and also a spacer of equivalent width.

void Index::extra_link?Usage of Index::extra_link:
Index Rules - §1, §8
Chart Element - §9
Innards Element - §1
Map Element - §2
Tables Element - §1.1(OUTPUT_STREAM, int id) {
    HTML_OPEN_WITH("a", "href=\"#\" onclick=\"showExtra('extra%d', 'plus%d'); return false;\"", id, id);
    HTML_TAG_WITH("img", "border=0 id=\"plus%d\" src=inform:/doc_images/extra.png", id);
    HTML_CLOSE("a");
    WRITE(" ");
}

void Index::extra_all_link_with?Usage of Index::extra_all_link_with:
Grouped Element - §1.4(OUTPUT_STREAM, int nr, char *icon) {
    HTML_OPEN_WITH("a", "href=\"#\" onclick=\"showAllResp(%d); return false;\"", nr);
    HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/%s.png", icon);
    HTML_CLOSE("a");
    WRITE(" ");
}

void Index::extra_link_with?Usage of Index::extra_link_with:
Index Rules - §4.2(OUTPUT_STREAM, int id, char *icon) {
    HTML_OPEN_WITH("a", "href=\"#\" onclick=\"showResp('extra%d', 'plus%d'); return false;\"", id, id);
    HTML_TAG_WITH("img", "border=0 id=\"plus%d\" src=inform:/doc_images/%s.png", id, icon);
    HTML_CLOSE("a");
    WRITE(" ");
}

void Index::noextra_link(OUTPUT_STREAM) {
    HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/noextra.png");
    WRITE(" ");
}

§6. These open up divisions:

void Index::extra_div_open?Usage of Index::extra_div_open:
Index Rules - §1, §8
Chart Element - §9
Innards Element - §1
Map Element - §2
Tables Element - §1.1(OUTPUT_STREAM, int id, int indent, char *colour) {
    HTML_OPEN_WITH("div", "id=\"extra%d\" style=\"display: none;\"", id);
    HTML::open_indented_p(OUT, indent, "");
    HTML::open_coloured_box(OUT, colour, ROUND_BOX_TOP+ROUND_BOX_BOTTOM);
}

void Index::extra_div_close?Usage of Index::extra_div_close:
Index Rules - §1, §8
Chart Element - §9
Innards Element - §1
Map Element - §2
Tables Element - §1.2(OUTPUT_STREAM, char *colour) {
    HTML::close_coloured_box(OUT, colour, ROUND_BOX_TOP+ROUND_BOX_BOTTOM);
    HTML_CLOSE("p");
    HTML_CLOSE("div");
}

void Index::extra_div_open_nested?Usage of Index::extra_div_open_nested:
Index Rules - §4.3(OUTPUT_STREAM, int id, int indent) {
    HTML_OPEN_WITH("div", "id=\"extra%d\" style=\"display: none;\"", id);
    HTML::open_indented_p(OUT, indent, "");
}

void Index::extra_div_close_nested?Usage of Index::extra_div_close_nested:
Index Rules - §4.3(OUTPUT_STREAM) {
    HTML_CLOSE("p");
    HTML_CLOSE("div");
}

§7. "Deprecation" icons.

void Index::deprecation_icon(OUTPUT_STREAM, int id) {
    HTML_OPEN_WITH("a", "href=\"#\" onclick=\"showExtra('extra%d', 'plus%d'); return false;\"", id, id);
    HTML_TAG_WITH("img", "border=0 src=inform:/doc_images/deprecated.png");
    HTML_CLOSE("a");
    WRITE(" ");
}

§8. Miscellaneous utilities. First: to print a double-quoted word into the index, without its surrounding quotes.

void Index::dequote(OUTPUT_STREAM, wchar_t *p) {
    int i = 1;
    if ((p[0] == 0) || (p[1] == 0)) return;
    for (i=1; p[i+1]; i++) {
        int c = p[i];
        switch(c) {
            case '"': WRITE("""); break;
            default: PUT_TO(OUT, c); break;
        }
    }
}

§9.

void Index::show_definition_area?Usage of Index::show_definition_area:
Values Element - §1.1.2(OUTPUT_STREAM, inter_package *heading_pack,
    int show_if_unhyphenated) {
    inter_ti parts = Metadata::read_optional_numeric(heading_pack, I"^parts");
    if ((parts == 1) && (show_if_unhyphenated == FALSE)) return;
    HTML_OPEN("b");
    switch (parts) {
        case 1: WRITE("%S", Metadata::read_optional_textual(heading_pack, I"^part1")); break;
        case 2: WRITE("%S", Metadata::read_optional_textual(heading_pack, I"^part2")); break;
        case 3: WRITE("%S - %S",
            Metadata::read_optional_textual(heading_pack, I"^part2"),
            Metadata::read_optional_textual(heading_pack, I"^part3")); break;
    }
    HTML_CLOSE("b");
    HTML_TAG("br");
}

§10.

void Index::explain?Usage of Index::explain:
§1.2(OUTPUT_STREAM, text_stream *explanation) {
    int italics_open = FALSE;
    for (int i=0, L=Str::len(explanation); i<L; i++) {
        switch (Str::get_at(explanation, i)) {
            case '|':
                HTML_TAG("br");
                WRITE("<i>"); italics_open = TRUE; break;
            case '<': {
                TEMPORARY_TEXT(link)
                WRITE("&nbsp;");
                i++;
                while ((i<L) && (Str::get_at(explanation, i) != '>'))
                    PUT_TO(link, Str::get_at(explanation, i++));
                Index::DocReferences::link(OUT, link);
                DISCARD_TEXT(link)
                break;
            }
            case '[': {
                TEMPORARY_TEXT(link)
                WRITE("&nbsp;");
                i++;
                while ((i<L) && (Str::get_at(explanation, i) != '>'))
                    PUT_TO(link, Str::get_at(explanation, i++));
                Index::below_link(OUT, link);
                DISCARD_TEXT(link)
                break;
            }
            default: WRITE("%c", Str::get_at(explanation, i)); break;
        }
    }
    if (italics_open) WRITE("</i>");
}