xidoc icon indicating copy to clipboard operation
xidoc copied to clipboard

Table of Contents in "commands.xd"

Open celtic-coder opened this issue 3 years ago • 2 comments

Hi Adam (@xigoi),

The Commands reference document is quite long. Might it be possible to include a Table of Contents (based on the "h2" headings), like the following:

  • Introduction
  • Top-level commands
  • HTML commands
  • CSS commands
  • Math commands

This will give the reader an overview of the content before they get caught up in the technical details. The document is well-written and comprehensive. Therefore, I believe, that a Table of Contents would make it easier to approach for a new user.

Kind Regards, Liam

celtic-coder avatar Feb 03 '22 18:02 celtic-coder

Sounds like a good idea! I'm planning to add a facility for generating a table of contents, but I'm not sure how to fit it into the single-pass nature of xidoc. I might add one manually though.

xigoi avatar Feb 10 '22 20:02 xigoi

OK, thanks!

celtic-coder avatar Feb 10 '22 23:02 celtic-coder

After a year of head-scratching, I've finally come up with a good way to implement a table of contents command. As a consequence, there is now a table of contents in the command reference.

xigoi avatar Mar 11 '23 15:03 xigoi

Great work, thanks! 👍

celtic-coder avatar Mar 11 '23 15:03 celtic-coder