On Sun, Mar 09, 2025 at 04:42:31PM +0000, Gavin Smith wrote:
> On Sat, Mar 08, 2025 at 12:46:14PM +0100, Patrice Dumas wrote:
> > On Sun, Mar 02, 2025 at 08:58:19PM +0000, Gavin Smith wrote:
> > > I've committed a (very short) change to texinfo.tex to implement 
> > > @xrefname.
> > 
> > I implemented in texi2any too.
> 
> I've written the documentation for it.  Could you check if the following
> is accurate?

Looks good to me, except that I am not sure that it is accurate that

 "This unstructured style of
  documentation is known as “topic-oriented documentation”".

A topic-based documentation does not follow the sectioning commands
hierarchical structure, but follows other structuring principles, such
as the guide/topic structure in the case of Mallard, it is not
unstructured.  I would leave out this sentence for now, and it would
probably become, when we are clearer on that topic-based navigation
in Texinfo something like

  "This style can be used for “topic-oriented documentation”, with
  .......(to be completed when it is in Texinfo, topic/guide...)...........

> Also, is there anything else we need to do to support the DITA or Mallard
> style of topic-oriented documentation?

I think that there needs to be a way to give information on the
relations between the "topics", like one is a guide, the other a topic
and they are associated, which topic is see also for another topic,
which one is a prerequisite for another and that kinds of relations.

For example in DocBook (which has a topics model that seems both too
complicated and underspecified to me, but could still give interesting
ideas):
https://tdg.docbook.org/tdg/5.2/ch06#relationships

-- 
Pat

Reply via email to