Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move GAPDocManualLab and GAPDocManualLabFromSixFile from GAP to GAPDoc, and possibly document them #5

Closed
fingolfin opened this issue Feb 8, 2017 · 6 comments

Comments

@fingolfin
Copy link
Contributor

The commands GAPDocManualLab and GAPDocManualLabFromSixFile are used by various packages when generating their manuals. It seems (but I might be wrong here?) that they are there to allow package manuals written using gapdocmacro to reference documentation in packages using GAPDoc?

If that's correct, perhaps most packages using GAPDocManualLab and GAPDocManualLabFromSixFile could stop using them?

If it's wrong, and there is still a need to call these, perhaps they should be documented?

Also, I am confused as to why they are in GAP, and not in GAPDoc -- GAPDoc even appears in their name, and they seem to serve no purpose if one uses another documentation system?

@frankluebeck
Copy link
Owner

The documented function GAPDocManualLab is needed when old gapmacro.tex manuals want to refer to GAPDoc style manuals. So, one could as well argue that this is a utility belonging to gapmacro.tex which is the reason why it is in the library.

@fingolfin
Copy link
Contributor Author

GAPDocManualLab is not in the GAP reference manual nor help system, so I'd consider it undocumented. Though I now see that package.gd contains a documentation comment for it, so perhaps it was meant to be documented, and this was just forgotten?

@frankluebeck
Copy link
Owner

Try:
?GAPDocManualLab

@olexandr-konovalov
Copy link

It's mentioned in one line of the guidance from the Example package and has an index entry there (the guidance that we indent to migrate to the GAP reference manual, but not completed yet in gap-system/gap#484).

If it's used, I suggest to hook the ManSection from package.gd to the GAP reference manual.

@frankluebeck
Copy link
Owner

If it's used, I suggest to hook the ManSection from package.gd to the GAP reference manual.

Yes, probably somewhere in the Chapter "84 Interface to the GAP Help System"

@olexandr-konovalov
Copy link

We have revised the chapter with the guidance for package authors, and it does not mention gapmacro.tex any more. Hence I think there no need to hook the ManSection on GAPDocManualLab from package.gd to the GAP reference manual either.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants