From ec1539606545041188d5af533b6a49b3c1ec06f0 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Tue, 15 Jul 2014 15:53:59 -0600 Subject: [PATCH] resolves #229 fix XML-friendly callout example --- docs/_includes/callout-xml.adoc | 10 +++++----- docs/_includes/ex-callout.adoc | 4 ++-- docs/asciidoc-syntax-quick-reference.adoc | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/_includes/callout-xml.adoc b/docs/_includes/callout-xml.adoc index bdb762238..3be58bf58 100644 --- a/docs/_includes/callout-xml.adoc +++ b/docs/_includes/callout-xml.adoc @@ -4,21 +4,21 @@ Included in: - user-manual: callouts: XML-friendly callouts //// -XML doesn't have line comments, so our "tuck the callout behind a line comment" trick doesn't work here. +XML doesn't have line comments, so our ``tuck the callout behind a line comment'' trick doesn't work here. To use callouts in XML, you must place the callout's angled brackets around the the XML comment and callout number. Here's how it appears in a listing: -[source] +[source,subs="specialcharacters"] .... -include::ex-callout.adoc[tags=non-xml] +include::ex-callout.adoc[tags=source-xml] .... Here's how it looks when rendered: ==== -include::ex-callout.adoc[tags=non-xml] +include::ex-callout.adoc[tags=source-xml] ==== -Notice the comment is gone. +Notice the comment has been replaced with a circled number that cannot be selected. Now both you and the reader can copy and paste XML source code containing callouts without worrying about errors. diff --git a/docs/_includes/ex-callout.adoc b/docs/_includes/ex-callout.adoc index 00fdc51d7..26392f21b 100644 --- a/docs/_includes/ex-callout.adoc +++ b/docs/_includes/ex-callout.adoc @@ -16,7 +16,7 @@ line of code ;; <3> <3> A callout behind a line comment for Clojure. // end::b-nonselect[] -// tag::non-xml[] +// tag::source-xml[] [source,xml] ----
@@ -24,7 +24,7 @@ line of code ;; <3>
---- <1> The section title is required. -// end::non-xml[] +// end::source-xml[] // tag::b-src[] [source,ruby] diff --git a/docs/asciidoc-syntax-quick-reference.adoc b/docs/asciidoc-syntax-quick-reference.adoc index 67f551c33..8e66c0f13 100644 --- a/docs/asciidoc-syntax-quick-reference.adoc +++ b/docs/asciidoc-syntax-quick-reference.adoc @@ -677,12 +677,12 @@ include::{includedir}/ex-callout.adoc[tags=b-nonselect] [listing, subs="specialcharacters"] .XML code block with a non-selectable callout .... -include::{includedir}/ex-callout.adoc[tags=non-xml] +include::{includedir}/ex-callout.adoc[tags=source-xml] .... [.result] ==== -include::{includedir}/ex-callout.adoc[tags=non-xml] +include::{includedir}/ex-callout.adoc[tags=source-xml] ==== [listing]