Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 24 May 2017 22:22:28 +1000
From:      Trev <freebsd-doc@sentry.org>
To:        freebsd-doc <freebsd-doc@FreeBSD.org>
Subject:   Re: having trouble making changes to the handbook
Message-ID:  <ff80e24d-b2da-4f94-54db-0053f64431a0@sentry.org>
In-Reply-To: <59257457.1090204@gmail.com>
References:  <592041FB.9030408@gmail.com> <20170522050544.GS39245@kduck.kaduk.org> <59231887.7090100@gmail.com> <20170523024852.GV39245@kduck.kaduk.org> <592474C7.3070900@gmail.com> <b44f9fd8-21a8-c847-bdbb-01ea01c4ecf2@sentry.org> <59257457.1090204@gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help
Ernie Luzar wrote on 24/05/2017 21:53:
>> Are you referring to the tags which comprise the XML markup?

> Yes the "chapter.xml" files with content enclosed with <  >  like
> <indexterm>  </indexterm>
> Is this markup notation referred to as "tags" or is "markup notations"
> the correct way to reference them as a group?

XML Markup comprises tags which are used to denote XML elements and 
attributes.

> Where are the intended usage meanings of all the different
> combinations of markup notations documented at?  Looking at the
> online handbook and back tracking to the xml markup notation is not a
> easy method of identifying the xml markup notation to use to add new
> information to the handbook information.

You need the DTD (document type definition) that is being used. The 
FreeBSD documentation uses the DocBook DTD.

If you've already installed the textproc/docbook-xml port, the DTD is 
part of it.

> Now here is the really puzzling question. How would I write
> documentation about these xml markup notations showing the real xml
> markup notation code in the doc without it being interpreted as
> something that gets converted? example
> <para>Here is what the xml markup notation code looks like;<title>As
> seem in the raw code.</title></para>

You would use the less than and greater than XML character entities in 
place of the less than and greater than signs. For example, &lt;para&gt;




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?ff80e24d-b2da-4f94-54db-0053f64431a0>