From 65f2698e90b54e3e149d0874d1e9e2cca97279ec Mon Sep 17 00:00:00 2001 From: BurdetteLamar Date: Mon, 8 Dec 2025 22:11:48 +0000 Subject: [PATCH 1/4] [DOC] Omit include files from html --- doc/rexml/tasks/includes/.document | 1 + doc/rexml/tasks/{tocs => includes}/child_toc.rdoc | 0 doc/rexml/tasks/{tocs => includes}/document_toc.rdoc | 0 doc/rexml/tasks/{tocs => includes}/element_toc.rdoc | 0 doc/rexml/tasks/{tocs => includes}/node_toc.rdoc | 0 doc/rexml/tasks/{tocs => includes}/parent_toc.rdoc | 0 doc/rexml/tasks/rdoc/child.rdoc | 2 +- doc/rexml/tasks/rdoc/document.rdoc | 2 +- doc/rexml/tasks/rdoc/element.rdoc | 2 +- doc/rexml/tasks/{tocs => rdoc}/master_toc.rdoc | 0 doc/rexml/tasks/rdoc/node.rdoc | 2 +- doc/rexml/tasks/rdoc/parent.rdoc | 2 +- 12 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 doc/rexml/tasks/includes/.document rename doc/rexml/tasks/{tocs => includes}/child_toc.rdoc (100%) rename doc/rexml/tasks/{tocs => includes}/document_toc.rdoc (100%) rename doc/rexml/tasks/{tocs => includes}/element_toc.rdoc (100%) rename doc/rexml/tasks/{tocs => includes}/node_toc.rdoc (100%) rename doc/rexml/tasks/{tocs => includes}/parent_toc.rdoc (100%) rename doc/rexml/tasks/{tocs => rdoc}/master_toc.rdoc (100%) diff --git a/doc/rexml/tasks/includes/.document b/doc/rexml/tasks/includes/.document new file mode 100644 index 00000000..aaf7a0bb --- /dev/null +++ b/doc/rexml/tasks/includes/.document @@ -0,0 +1 @@ +# Don't make html for these include files. diff --git a/doc/rexml/tasks/tocs/child_toc.rdoc b/doc/rexml/tasks/includes/child_toc.rdoc similarity index 100% rename from doc/rexml/tasks/tocs/child_toc.rdoc rename to doc/rexml/tasks/includes/child_toc.rdoc diff --git a/doc/rexml/tasks/tocs/document_toc.rdoc b/doc/rexml/tasks/includes/document_toc.rdoc similarity index 100% rename from doc/rexml/tasks/tocs/document_toc.rdoc rename to doc/rexml/tasks/includes/document_toc.rdoc diff --git a/doc/rexml/tasks/tocs/element_toc.rdoc b/doc/rexml/tasks/includes/element_toc.rdoc similarity index 100% rename from doc/rexml/tasks/tocs/element_toc.rdoc rename to doc/rexml/tasks/includes/element_toc.rdoc diff --git a/doc/rexml/tasks/tocs/node_toc.rdoc b/doc/rexml/tasks/includes/node_toc.rdoc similarity index 100% rename from doc/rexml/tasks/tocs/node_toc.rdoc rename to doc/rexml/tasks/includes/node_toc.rdoc diff --git a/doc/rexml/tasks/tocs/parent_toc.rdoc b/doc/rexml/tasks/includes/parent_toc.rdoc similarity index 100% rename from doc/rexml/tasks/tocs/parent_toc.rdoc rename to doc/rexml/tasks/includes/parent_toc.rdoc diff --git a/doc/rexml/tasks/rdoc/child.rdoc b/doc/rexml/tasks/rdoc/child.rdoc index 89536381..b46bb533 100644 --- a/doc/rexml/tasks/rdoc/child.rdoc +++ b/doc/rexml/tasks/rdoc/child.rdoc @@ -3,7 +3,7 @@ Class Child includes module Node; see {Tasks for Node}[node_rdoc.html]. -:include: ../tocs/child_toc.rdoc +:include: ../includes/child_toc.rdoc === Relationships diff --git a/doc/rexml/tasks/rdoc/document.rdoc b/doc/rexml/tasks/rdoc/document.rdoc index 96d03351..02557d57 100644 --- a/doc/rexml/tasks/rdoc/document.rdoc +++ b/doc/rexml/tasks/rdoc/document.rdoc @@ -9,7 +9,7 @@ see: - {Tasks for Node}[node_rdoc.html]. - {Module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html]. -:include: ../tocs/document_toc.rdoc +:include: ../includes/document_toc.rdoc === New Document diff --git a/doc/rexml/tasks/rdoc/element.rdoc b/doc/rexml/tasks/rdoc/element.rdoc index 4b3609b0..ff07cd07 100644 --- a/doc/rexml/tasks/rdoc/element.rdoc +++ b/doc/rexml/tasks/rdoc/element.rdoc @@ -8,7 +8,7 @@ see: - {Tasks for Node}[node_rdoc.html]. - {Module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html]. -:include: ../tocs/element_toc.rdoc +:include: ../includes/element_toc.rdoc === New Element diff --git a/doc/rexml/tasks/tocs/master_toc.rdoc b/doc/rexml/tasks/rdoc/master_toc.rdoc similarity index 100% rename from doc/rexml/tasks/tocs/master_toc.rdoc rename to doc/rexml/tasks/rdoc/master_toc.rdoc diff --git a/doc/rexml/tasks/rdoc/node.rdoc b/doc/rexml/tasks/rdoc/node.rdoc index d5d2e12a..d2e8f4dc 100644 --- a/doc/rexml/tasks/rdoc/node.rdoc +++ b/doc/rexml/tasks/rdoc/node.rdoc @@ -1,6 +1,6 @@ == Module Node -:include: ../tocs/node_toc.rdoc +:include: ../includes/node_toc.rdoc === Siblings diff --git a/doc/rexml/tasks/rdoc/parent.rdoc b/doc/rexml/tasks/rdoc/parent.rdoc index 54f1dbe3..76befd12 100644 --- a/doc/rexml/tasks/rdoc/parent.rdoc +++ b/doc/rexml/tasks/rdoc/parent.rdoc @@ -7,7 +7,7 @@ see: - {Tasks for Node}[node_rdoc.html]. - {Module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html]. -:include: ../tocs/parent_toc.rdoc +:include: ../includes/parent_toc.rdoc === Queries From 54ad82a7afc221ee238c51a361012234fb7a87a7 Mon Sep 17 00:00:00 2001 From: BurdetteLamar Date: Mon, 8 Dec 2025 23:10:16 +0000 Subject: [PATCH 2/4] [DOC] Fix links to tasks --- lib/rexml/document.rb | 4 ++-- lib/rexml/element.rb | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/rexml/document.rb b/lib/rexml/document.rb index bd3a0045..45467fe9 100644 --- a/lib/rexml/document.rb +++ b/lib/rexml/document.rb @@ -28,9 +28,9 @@ module REXML # If you're somewhat familiar with XML # and have a particular task in mind, # you may want to see the - # {tasks pages}[../doc/rexml/tasks/tocs/master_toc_rdoc.html], + # {tasks pages}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html], # and in particular, the - # {tasks page for documents}[../doc/rexml/tasks/tocs/document_toc_rdoc.html]. + # {tasks for documents}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html#label-Document]. # class Document < Element # A convenient default XML declaration. Use: diff --git a/lib/rexml/element.rb b/lib/rexml/element.rb index 0d74811e..d33b94e2 100644 --- a/lib/rexml/element.rb +++ b/lib/rexml/element.rb @@ -24,9 +24,9 @@ module REXML # If you're somewhat familiar with XML # and have a particular task in mind, # you may want to see the - # {tasks pages}[../doc/rexml/tasks/tocs/master_toc_rdoc.html], + # {tasks pages}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html], # and in particular, the - # {tasks page for elements}[../doc/rexml/tasks/tocs/element_toc_rdoc.html]. + # {tasks for elements}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html#label-Element]. # # === Name # From 10be7afba14c02b7f548bb586be215a606063f1e Mon Sep 17 00:00:00 2001 From: BurdetteLamar Date: Thu, 18 Dec 2025 04:43:31 +0000 Subject: [PATCH 3/4] [DOC] Rename task toc file --- doc/rexml/tasks/rdoc/{master_toc.rdoc => toc.rdoc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/rexml/tasks/rdoc/{master_toc.rdoc => toc.rdoc} (100%) diff --git a/doc/rexml/tasks/rdoc/master_toc.rdoc b/doc/rexml/tasks/rdoc/toc.rdoc similarity index 100% rename from doc/rexml/tasks/rdoc/master_toc.rdoc rename to doc/rexml/tasks/rdoc/toc.rdoc From 4df26a4518beb843d619475b4eb9c38e30d3779d Mon Sep 17 00:00:00 2001 From: BurdetteLamar Date: Thu, 18 Dec 2025 11:33:17 +0000 Subject: [PATCH 4/4] [DOC] Fix links to tasks toc --- lib/rexml/document.rb | 4 ++-- lib/rexml/element.rb | 4 ++-- lib/rexml/rexml.rb | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/rexml/document.rb b/lib/rexml/document.rb index 45467fe9..3d61dc07 100644 --- a/lib/rexml/document.rb +++ b/lib/rexml/document.rb @@ -28,9 +28,9 @@ module REXML # If you're somewhat familiar with XML # and have a particular task in mind, # you may want to see the - # {tasks pages}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html], + # {tasks pages}[../doc/rexml/tasks/rdoc/toc_rdoc.html], # and in particular, the - # {tasks for documents}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html#label-Document]. + # {tasks for documents}[../doc/rexml/tasks/rdoc/toc_rdoc.html#label-Document]. # class Document < Element # A convenient default XML declaration. Use: diff --git a/lib/rexml/element.rb b/lib/rexml/element.rb index d33b94e2..abdb28a7 100644 --- a/lib/rexml/element.rb +++ b/lib/rexml/element.rb @@ -24,9 +24,9 @@ module REXML # If you're somewhat familiar with XML # and have a particular task in mind, # you may want to see the - # {tasks pages}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html], + # {tasks pages}[../doc/rexml/tasks/rdoc/toc_rdoc.html], # and in particular, the - # {tasks for elements}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html#label-Element]. + # {tasks for elements}[../doc/rexml/tasks/rdoc/toc_rdoc.html#label-Element]. # # === Name # diff --git a/lib/rexml/rexml.rb b/lib/rexml/rexml.rb index cd865f25..4a126fb5 100644 --- a/lib/rexml/rexml.rb +++ b/lib/rexml/rexml.rb @@ -18,7 +18,7 @@ # # If you're somewhat familiar with XML # and have a particular task in mind, -# you may want to see {the tasks pages}[doc/rexml/tasks/tocs/master_toc_rdoc.html]. +# you may want to see {the tasks pages}[doc/rexml/tasks/rdoc/toc_rdoc.html]. # # == API #