2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-14 19:56:54 +03:00
< title > Main< / title >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-03-17 14:40:57 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-05-03 03:01:21 +03:00
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-14 19:56:54 +03:00
2019-03-17 14:40:57 +02:00
< / head >
2020-05-03 03:01:21 +03:00
< body class = "commentary-font" >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2020-04-14 19:56:54 +03:00
< h1 > < a href = "../index.html" >
2020-05-03 18:34:53 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
2020-04-14 19:56:54 +03:00
< / a > < / h1 >
< ul > < li > < a href = "../compiler.html" > compiler tools< / a > < / li >
< li > < a href = "../other.html" > other tools< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../extensions.html" > extensions and kits< / a > < / li >
< li > < a href = "../units.html" > unit test tools< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Other Tools< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inblorb/index.html" > inblorb< / a > < / li >
2020-04-14 19:56:54 +03:00
< li > < a href = "index.html" > < span class = "selectedlink" > indoc< / span > < / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inpolicy/index.html" > inpolicy< / a > < / li >
< li > < a href = "../inrtps/index.html" > inrtps< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Foundation< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2020-05-03 03:01:21 +03:00
<!-- Weave of 'Main' generated by Inweb -->
< div class = "breadcrumbs" >
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../other.html" > Other Tools< / a > < / li > < li > < a href = "index.html" > indoc< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Setting Up< / a > < / li > < li > < b > Main< / b > < / li > < / ul > < / div >
< p class = "purpose" > The top level of the program.< / p >
2019-03-17 14:40:57 +02:00
2020-04-16 01:49:59 +03:00
< ul class = "toc" > < li > < a href = "1-mn.html#SP1" > § 1. Nutshell< / a > < / li > < li > < a href = "1-mn.html#SP1_1" > § 1.1. Starting up< / a > < / li > < li > < a href = "1-mn.html#SP1_2" > § 1.2. First and second passes< / a > < / li > < li > < a href = "1-mn.html#SP1_6" > § 1.6. Shutting down< / a > < / li > < / ul > < hr class = "tocbar" >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1" > < / a > < b > § 1. Nutshell. < / b > We turn the source matter, "rawtext", into a batch of output files using the
2019-03-17 14:40:57 +02:00
chosen format, a process we'll call "rendering". We do this in two passes.
< / p >
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > pathname< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > path_to_indoc< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > where we are installed< / span >
< span class = "reserved-syntax" > pathname< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > path_to_indoc_materials< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > the materials pathname< / span >
< span class = "reserved-syntax" > settings_block< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > no_volumes< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > no_examples< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > main< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > argc< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > char< / span > < span class = "plain-syntax" > **< / span > < span class = "identifier-syntax" > argv< / span > < span class = "plain-syntax" > ) {< / span >
2020-07-05 13:01:27 +03:00
< span class = "plain-syntax" > < / span > < a href = "1-bsc.html#SP1" class = "function-link" > < span class = "function-syntax" > Basics::start< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > argc< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > argv< / span > < span class = "plain-syntax" > );< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-mn.html#SP1_1" class = "named-paragraph-link" > < span class = "named-paragraph" > Start up indoc< / span > < span class = "named-paragraph-number" > 1.1< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-mn.html#SP1_2" class = "named-paragraph-link" > < span class = "named-paragraph" > Make a first-pass scan of the rawtext< / span > < span class = "named-paragraph-number" > 1.2< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-mn.html#SP1_3" class = "named-paragraph-link" > < span class = "named-paragraph" > Render the rawtext as documentation< / span > < span class = "named-paragraph-number" > 1.3< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > html_for_Inform_application< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-mn.html#SP1_4" class = "named-paragraph-link" > < span class = "named-paragraph" > Work out cross-references for the in-application documentation only< / span > < span class = "named-paragraph-number" > 1.4< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-mn.html#SP1_5" class = "named-paragraph-link" > < span class = "named-paragraph" > Produce the indexes< / span > < span class = "named-paragraph-number" > 1.5< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < a href = "2-haj.html#SP7" class = "function-link" > < span class = "function-syntax" > HTMLUtilities::copy_images< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > wrapper< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > WRAPPER_epub< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "2-haj.html#SP5" class = "function-link" > < span class = "function-syntax" > HTMLUtilities::note_images< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "2-ss.html#SP8" class = "function-link" > < span class = "function-syntax" > Scanner::mark_up_ebook< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/5-ee.html#SP7" class = "function-link" > < span class = "function-syntax" > Epub::end_construction< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ebook< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-mn.html#SP1_6" class = "named-paragraph-link" > < span class = "named-paragraph" > Shut down indoc< / span > < span class = "named-paragraph-number" > 1.6< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < a href = "1-bsc.html#SP1" class = "function-link" > < span class = "function-syntax" > Basics::end< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1_1" > < / a > < b > § 1.1. Starting up. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Start up indoc< / span > < span class = "named-paragraph-number" > 1.1< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PRINT< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "indoc [[Version Number]] (Inform Tools Suite)\n"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "4-nd.html#SP1" class = "function-link" > < span class = "function-syntax" > Nav::start< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "1-cs.html#SP2" class = "function-link" > < span class = "function-syntax" > Symbols::start_up_symbols< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > = < / span > < a href = "1-ins.html#SP2" class = "function-link" > < span class = "function-syntax" > Instructions::clean_slate< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "1-cnf.html#SP2" class = "function-link" > < span class = "function-syntax" > Configuration::read_command_line< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > argc< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > argv< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > wrapper< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > WRAPPER_epub< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "2-haj.html#SP4" class = "function-link" > < span class = "function-syntax" > HTMLUtilities::image_URL< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/3-fln.html#SP7" class = "function-link" > < span class = "function-syntax" > Filenames::get_leafname< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > book_cover_image< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ins.html#SP10" class = "function-link" > < span class = "function-syntax" > Instructions::apply_ebook_metadata< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ebook< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > pathname< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/docs/foundation-module/3-pth.html#SP5" class = "function-link" > < span class = "function-syntax" > Pathnames::from_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "images"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > cover_in_situ< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/docs/foundation-module/3-fln.html#SP2" class = "function-link" > < span class = "function-syntax" > Filenames::in< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/3-fln.html#SP7" class = "function-link" > < span class = "function-syntax" > Filenames::get_leafname< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > book_cover_image< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > destination< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/docs/foundation-module/5-ee.html#SP6" class = "function-link" > < span class = "function-syntax" > Epub::begin_construction< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ebook< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > destination< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > cover_in_situ< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > NUMBER_CREATED< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > ) == < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) { < / span > < span class = "identifier-syntax" > PRINT< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "indoc: nothing to do\n"< / span > < span class = "plain-syntax" > ); < / span > < span class = "identifier-syntax" > exit< / span > < span class = "plain-syntax" > (0); }< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > problem_count< / span > < span class = "plain-syntax" > > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > exit< / span > < span class = "plain-syntax" > (1);< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-mn.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP1_2" > < / a > < b > § 1.2. First and second passes. < / b > First we look ahead, so to speak, by scanning the examples we are going
2019-03-17 14:40:57 +02:00
to need to insert; then similarly to find the section titles. At this
point, nothing is being output.
< / p >
2020-05-03 03:01:21 +03:00
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Make a first-pass scan of the rawtext< / span > < span class = "named-paragraph-number" > 1.2< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > LOOP_OVER< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > ) < / span > < a href = "2-ss.html#SP6" class = "function-link" > < span class = "function-syntax" > Scanner::scan_rawtext_for_section_titles< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > book_contains_examples< / span > < span class = "plain-syntax" > ) < / span > < a href = "2-exm.html#SP5" class = "function-link" > < span class = "function-syntax" > Examples::scan_examples< / span > < / a > < span class = "plain-syntax" > ();< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-mn.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP1_3" > < / a > < b > § 1.3. < / b > We then work through each volume's rawtext file in turn, writing the output
2019-03-17 14:40:57 +02:00
section by section.
< / p >
2020-05-03 03:01:21 +03:00
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Render the rawtext as documentation< / span > < span class = "named-paragraph-number" > 1.3< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > format< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > HTML_FORMAT< / span > < span class = "plain-syntax" > ) < / span > < a href = "2-css.html#SP5" class = "function-link" > < span class = "function-syntax" > CSS::write_CSS_files< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > css_source_file< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > TO< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > LOOP_OVER< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > TO< / span > < span class = "plain-syntax" > = < / span > < a href = "2-rr.html#SP1" class = "function-link" > < span class = "function-syntax" > Rawtext::process_large_rawtext_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > TO< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "4-nd.html#SP8" class = "function-link" > < span class = "function-syntax" > Nav::render_navigation_contents_files< / span > < / a > < span class = "plain-syntax" > ();< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-mn.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP1_4" > < / a > < b > § 1.4. < / b > The following functions here are for use only when compiling documentation
2019-03-17 14:40:57 +02:00
to go inside the Inform user interface application.
< / p >
2020-05-03 03:01:21 +03:00
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Work out cross-references for the in-application documentation only< / span > < span class = "named-paragraph-number" > 1.4< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < a href = "2-ss.html#SP7" class = "function-link" > < span class = "function-syntax" > Scanner::write_manifest_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > FIRST_OBJECT< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > definitions_filename< / span > < span class = "plain-syntax" > ) < / span > < a href = "2-utc.html#SP3" class = "function-link" > < span class = "function-syntax" > Updater::write_definitions_file< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > xrefs_filename< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "2-utc.html#SP2" class = "function-link" > < span class = "function-syntax" > Updater::write_xrefs_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > xrefs_filename< / span > < span class = "plain-syntax" > );< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-mn.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP1_5" > < / a > < b > § 1.5. < / b > These are automatically generated.
2019-03-17 14:40:57 +02:00
< / p >
2020-05-03 03:01:21 +03:00
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Produce the indexes< / span > < span class = "named-paragraph-number" > 1.5< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > indoc_settings< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > format< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > HTML_FORMAT< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > no_examples< / span > < span class = "plain-syntax" > > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "3-ei.html#SP3" class = "function-link" > < span class = "function-syntax" > ExamplesIndex::write_alphabetical_examples_index< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "3-ei.html#SP6" class = "function-link" > < span class = "function-syntax" > ExamplesIndex::write_numerical_examples_index< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "3-ei.html#SP5" class = "function-link" > < span class = "function-syntax" > ExamplesIndex::write_thematic_examples_index< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > NUMBER_CREATED< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > index_lemma< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < a href = "3-gi.html#SP9" class = "function-link" > < span class = "function-syntax" > Indexes::write_general_index< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-mn.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP1_6" > < / a > < b > § 1.6. Shutting down. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Shut down indoc< / span > < span class = "named-paragraph-number" > 1.6< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > problem_count< / span > < span class = "plain-syntax" > > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PRINT< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "indoc: ended with error%s\n"< / span > < span class = "plain-syntax" > , (< / span > < span class = "identifier-syntax" > problem_count< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > )?< / span > < span class = "string-syntax" > ""< / span > < span class = "plain-syntax" > :< / span > < span class = "string-syntax" > "s"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > exit< / span > < span class = "plain-syntax" > (1);< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > LOOP_OVER< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > += < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > vol_section_count< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PRINT< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "indoc: done (%d volume%s, %d section%s, %d example%s)\n"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > no_volumes< / span > < span class = "plain-syntax" > , (< / span > < span class = "identifier-syntax" > problem_count< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > )?< / span > < span class = "string-syntax" > ""< / span > < span class = "plain-syntax" > :< / span > < span class = "string-syntax" > "s"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > , (< / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > )?< / span > < span class = "string-syntax" > ""< / span > < span class = "plain-syntax" > :< / span > < span class = "string-syntax" > "s"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > no_examples< / span > < span class = "plain-syntax" > , (< / span > < span class = "identifier-syntax" > no_examples< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > )?< / span > < span class = "string-syntax" > ""< / span > < span class = "plain-syntax" > :< / span > < span class = "string-syntax" > "s"< / span > < span class = "plain-syntax" > );< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-mn.html#SP1" > § 1< / a > .< / li > < / ul >
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "1-bsc.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "M-iti.html" > M< / a > < / li > < li class = "progresscurrentchapter" > 1< / li > < li class = "progresssection" > < a href = "1-bsc.html" > bsc< / a > < / li > < li class = "progresscurrent" > mn< / li > < li class = "progresssection" > < a href = "1-cnf.html" > cnf< / a > < / li > < li class = "progresssection" > < a href = "1-ins.html" > ins< / a > < / li > < li class = "progresssection" > < a href = "1-cs.html" > cs< / a > < / li > < li class = "progresschapter" > < a href = "2-ss.html" > 2< / a > < / li > < li class = "progresschapter" > < a href = "3-iu.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-nd.html" > 4< / a > < / li > < li class = "progressnext" > < a href = "1-cnf.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
2019-03-17 14:40:57 +02:00
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >