Removed START EXAMPLE and END EXAMPLE comments

ganelson · Jul 28, 2024 · b3031db · b3031db
1 parent e1c52b9
commit b3031db
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Inform 7
 
-[Version](notes/versioning.md): 10.2.0-beta+6X70 'Krypton' (25 July 2024)
+[Version](notes/versioning.md): 10.2.0-beta+6X71 'Krypton' (28 July 2024)
 
 ## About Inform
 

diff --git a/build.txt b/build.txt
@@ -1,3 +1,3 @@
 Prerelease: beta
-Build Date: 25 July 2024
-Build Number: 6X70
+Build Date: 28 July 2024
+Build Number: 6X71
diff --git a/inbuild/supervisor-module/Chapter 7/Documentation Renderer.w b/inbuild/supervisor-module/Chapter 7/Documentation Renderer.w
@@ -693,20 +693,14 @@ void DocumentationRenderer::render_example(OUTPUT_STREAM, compiled_documentation
 		HTML_OPEN_WITH("div", "class=\"markdowncontent\"");
 		InformFlavouredMarkdown::render_example_heading(OUT, E, NULL);
 		HTML::comment(OUT, I"CONTENT BEGINS");
-		TEMPORARY_TEXT(eg_comment)
-		WRITE_TO(eg_comment, "START EXAMPLE \"%S: %S\" \"eganchor%S\"",
-			egc->insignia, egc->name, egc->insignia);
 		@<Place example searchability comments@>;
-		HTML::comment(OUT, eg_comment);
-		DISCARD_TEXT(eg_comment)
-		HTML_OPEN_WITH("a", "id=\"eganchor%S\"", egc->insignia);
-		HTML_CLOSE("a");
+		@<Place example start comments@>;
 		markdown_item *passage_node = alt_EN->down;
 		while (passage_node) {
 			DocumentationRenderer::render_extended(OUT, cd, passage_node);
 			passage_node = passage_node->next;
 		}
-		HTML::comment(OUT, I"END EXAMPLE");
+		@<Place example end comment@>;
 		HTML::comment(OUT, I"CONTENT ENDS");
 		HTML_CLOSE("div");
 		@<Enter the small print@>;
@@ -722,6 +716,27 @@ void DocumentationRenderer::render_example(OUTPUT_STREAM, compiled_documentation
 	}
 }
 
+@ In the days of |indoc|, comments like these were used to show where inlined
+examples (i.e., examples rendered inside the body of sections of documentation
+rather than in their own individual HTML files) began. They're no longer
+needed because examples are no longer inlined.
+
+@<Place example start comments@> =
+	if (FALSE) {
+		TEMPORARY_TEXT(eg_comment)
+		WRITE_TO(eg_comment, "START EXAMPLE \"%S: %S\" \"eganchor%S\"",
+			egc->insignia, egc->name, egc->insignia);
+		HTML::comment(OUT, eg_comment);
+		DISCARD_TEXT(eg_comment)
+		HTML_OPEN_WITH("a", "id=\"eganchor%S\"", egc->insignia);
+		HTML_CLOSE("a");
+	}
+
+@<Place example end comment@> =
+	if (FALSE) {
+		HTML::comment(OUT, I"END EXAMPLE");
+	}
+
 @<Place example searchability comments@> =
 	int en = 0;
 	match_results mr = Regexp::create_mr();

diff --git a/.../Graham Nelson/English Language.i7xd/Materials/Inter/EnglishLanguageKit/kit_metadata.json b/.../Graham Nelson/English Language.i7xd/Materials/Inter/EnglishLanguageKit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "EnglishLanguageKit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "needs": [ {
         "need": {

diff --git a/inform7/Internal/Inter/Architecture16Kit/kit_metadata.json b/inform7/Internal/Inter/Architecture16Kit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "Architecture16Kit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "compatibility": "16-bit",
     "kit-details": {

diff --git a/inform7/Internal/Inter/Architecture32Kit/kit_metadata.json b/inform7/Internal/Inter/Architecture32Kit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "Architecture32Kit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "compatibility": "32-bit",
     "kit-details": {

diff --git a/inform7/Internal/Inter/BasicInformKit/kit_metadata.json b/inform7/Internal/Inter/BasicInformKit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "BasicInformKit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "needs": [ {
         "need": {

diff --git a/inform7/Internal/Inter/CommandParserKit/kit_metadata.json b/inform7/Internal/Inter/CommandParserKit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "CommandParserKit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "needs": [ {
         "need": {

diff --git a/inform7/Internal/Inter/DialogueKit/kit_metadata.json b/inform7/Internal/Inter/DialogueKit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "DialogueKit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "activates": [ "dialogue" ],
     "kit-details": {

diff --git a/inform7/Internal/Inter/WorldModelKit/kit_metadata.json b/inform7/Internal/Inter/WorldModelKit/kit_metadata.json
@@ -2,7 +2,7 @@
     "is": {
         "type": "kit",
         "title": "WorldModelKit",
-        "version": "10.2.0-beta+6X70"
+        "version": "10.2.0-beta+6X71"
     },
     "needs": [ {
         "need": {