Debian Codegraph @

tst/worksheets/autoplain.expected/_Chapter_Test.xml

raw
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!-- This is an automatically generated file. -->
4 <Chapter Label="Chapter_Test">
5 <Heading>Test</Heading>
6
7 Does AutoDoc have a way to allow that header block not to appear in
8 the documentation generated from a <F>.autodoc</F> file like this?
9 <Section Label="Chapter_Test_Section_First_Section">
10 <Heading>First Section</Heading>
11
12 <Subsection Label="Chapter_Test_Section_First_Section_Subsection_First_Subsection">
13 <Heading>First Subsection</Heading>
14
15 <Example><![CDATA[
16 gap> S5 := SymmetricGroup(5);
17 Sym( [ 1 .. 5 ] )
18 gap> Size(S5);
19 120
20 ]]></Example>
21
22 Some text between two examples
23 <Index Key="Worksheet Autoplain">Plain worksheet index entry with <Keyword>true</Keyword></Index>
24 <Index Key="WorksheetAutoplainKeyOnly"></Index>
25 <Index Key="A&amp;B">ampersand key</Index>
26 <Index Key="A&lt;B">less-than key</Index>
27 <Index Key="Indented Autoplain">indented command parsing works</Index>
28 <Example><![CDATA[
29 gap> A5 := AlternatingGroup(5);
30 Alt( [ 1 .. 5 ] )
31 gap> Size(A5);
32 60
33 ]]></Example>
34
35 <Example><![CDATA[
36 gap> plain_mode_value := 6 *
37 > 9;
38 54
39 ]]></Example>
40
41 A plain-text line mentioning @Section InlineMention should stay plain text.
42 And an unfenced .autodoc line beginning with #! should stay literal:
43 #! PlainAutodocLiteral
44 And fenced listings in .autodoc files should also keep would-be comments literal:
45 <Listing><![CDATA[
46 @Section PlainTextFenceLiteral
47 #! PlainFenceLiteral
48 ]]></Listing>
49 Also, markdown-like inline <Keyword>true</Keyword> should become a keyword tag.
50 And XML comments should pass through verbatim:
51 <!--
52 # <#GAPDoc Label="ToricVarietyConst">
53 # <ManSection>
54 # <#/GAPDoc>
55 -->
56 And XML CDATA blocks should also keep would-be commands literal:
57 <Listing><![CDATA[
58 # PlainCDATAHeading
59 ## PlainCDATASection
60 @Section PlainCDATACommand
61 #! PlainCDATAComment
62 ]]></Listing>
63 And we wrap up with some dummy text
64 </Subsection>
65
66 </Section>
67
68 </Chapter>
69