AutoDoc chunks allow inserting some documentation in another place than where it was defined, and also to insert it multiple times. GAPDoc has a similar feature, based on the <#Include Label="..."> and <#GAPDoc Label="..."> XML elements. However, those two systems right now are not really interoperable. It would be great if they were, i.e. if I could include AutoDoc chunks from within GAPDoc XML, and vice versa.
A potential way to get that w/o breaking existing manuals might be to do change how we implement chunks: instead of inserting them in the generated XML code in every place, instead put them into a single doc/_AutoDoc_chunks.xml (or doc/_Chunks.xml or whatever) file, inside <#GAPDoc Label="..."> elements. Then, in all places where we currently emit a chunk, we instead simply emit the corresponding <#Include Label="...">. Finally, we must make sure that GAPDoc sees the XML file with all the chunks as input.
This would then make it much easier to gradually convert existing GAPDoc manuals to use AutoDoc.
AutoDoc chunks allow inserting some documentation in another place than where it was defined, and also to insert it multiple times. GAPDoc has a similar feature, based on the
<#Include Label="...">and<#GAPDoc Label="...">XML elements. However, those two systems right now are not really interoperable. It would be great if they were, i.e. if I could include AutoDoc chunks from within GAPDoc XML, and vice versa.A potential way to get that w/o breaking existing manuals might be to do change how we implement chunks: instead of inserting them in the generated XML code in every place, instead put them into a single
doc/_AutoDoc_chunks.xml(ordoc/_Chunks.xmlor whatever) file, inside<#GAPDoc Label="...">elements. Then, in all places where we currently emit a chunk, we instead simply emit the corresponding<#Include Label="...">. Finally, we must make sure that GAPDoc sees the XML file with all the chunks as input.This would then make it much easier to gradually convert existing GAPDoc manuals to use AutoDoc.