| 1 |
<?xml version="1.0" encoding="UTF-8"?> |
| 2 |
|
| 3 |
<!-- This is an automatically generated file. --> |
| 4 |
<Chapter Label="Chapter_SomeChapter"> |
| 5 |
<Heading>SomeChapter</Heading> |
| 6 |
|
| 7 |
This is dummy text |
| 8 |
<Example><![CDATA[ |
| 9 |
gap> S5 := SymmetricGroup(5); |
| 10 |
Sym( [ 1 .. 5 ] ) |
| 11 |
gap> Size(S5); |
| 12 |
120 |
| 13 |
]]></Example> |
| 14 |
|
| 15 |
Some text between two examples |
| 16 |
<Index Key="Worksheet General">General worksheet index entry with <Keyword>true</Keyword></Index> |
| 17 |
<Index Key="WorksheetGeneralKeyOnly"></Index> |
| 18 |
<Index Key="A>B">greater-than key</Index> |
| 19 |
<Index Key="A"B">quote key</Index> |
| 20 |
<Example><![CDATA[ |
| 21 |
gap> A5 := AlternatingGroup(5); |
| 22 |
Alt( [ 1 .. 5 ] ) |
| 23 |
gap> Size(A5); |
| 24 |
60 |
| 25 |
gap> # Test whether ]]]]><![CDATA[> can be used safely |
| 26 |
gap> [[2]]]]><![CDATA[>[[1]]; |
| 27 |
true |
| 28 |
]]></Example> |
| 29 |
|
| 30 |
<Example><![CDATA[ |
| 31 |
gap> comment_mode_value := 6 * |
| 32 |
> 7; |
| 33 |
42 |
| 34 |
]]></Example> |
| 35 |
|
| 36 |
And we wrap up with some dummy text |
| 37 |
<Section Label="Chapter_SomeChapter_Section_Some_categories"> |
| 38 |
<Heading>Some categories</Heading> |
| 39 |
|
| 40 |
Intro text |
| 41 |
<ManSection> |
| 42 |
<Filt Arg="arg" Type="Category" Name="MyThings" Label="for IsObject"/> |
| 43 |
<Returns><K>true</K> or <K>false</K> |
| 44 |
</Returns> |
| 45 |
<Description> |
| 46 |
<P/> |
| 47 |
</Description> |
| 48 |
</ManSection> |
| 49 |
|
| 50 |
<ManSection> |
| 51 |
<Filt Arg="obj" Type="Collection" Name="MyThingsCollection" /> |
| 52 |
<Returns><K>true</K> or <K>false</K> |
| 53 |
</Returns> |
| 54 |
<Description> |
| 55 |
<P/> |
| 56 |
</Description> |
| 57 |
</ManSection> |
| 58 |
|
| 59 |
<ManSection> |
| 60 |
<Filt Arg="obj" Type="Collection" Name="MyThingsCollColl" /> |
| 61 |
<Returns><K>true</K> or <K>false</K> |
| 62 |
</Returns> |
| 63 |
<Description> |
| 64 |
<P/> |
| 65 |
</Description> |
| 66 |
</ManSection> |
| 67 |
|
| 68 |
Let's wrap up with something, though. |
| 69 |
</Section> |
| 70 |
|
| 71 |
<Section Label="Chapter_SomeChapter_Section_SomeSection"> |
| 72 |
<Heading>SomeSection</Heading> |
| 73 |
|
| 74 |
Some test just inside a section. |
| 75 |
<Subsection Label="Chapter_SomeChapter_Section_SomeSection_Subsection_SomeSubsection"> |
| 76 |
<Heading>SomeSubsection</Heading> |
| 77 |
|
| 78 |
This is a subsection! |
| 79 |
</Subsection> |
| 80 |
|
| 81 |
<Subsection Label="Chapter_SomeChapter_Section_SomeSection_Subsection_MarkDown_support"> |
| 82 |
<Heading>MarkDown support</Heading> |
| 83 |
|
| 84 |
<P/> |
| 85 |
We can use test some markdown features here: |
| 86 |
<List> |
| 87 |
<Item> |
| 88 |
This is a list item. |
| 89 |
<List> |
| 90 |
<Item> |
| 91 |
This is a subitem |
| 92 |
</Item> |
| 93 |
<Item> |
| 94 |
We can also use math mode here: <Math>a^2+b^2=c^2</Math>. |
| 95 |
</Item> |
| 96 |
</List> |
| 97 |
</Item> |
| 98 |
<Item> |
| 99 |
This is <Emph>emphasized</Emph> text in a list item. |
| 100 |
</Item> |
| 101 |
<Item> |
| 102 |
This is also <Emph>emphasized</Emph> text in a list item. |
| 103 |
</Item> |
| 104 |
<Item> |
| 105 |
This is <Code>inline code</Code> in a list item. |
| 106 |
</Item> |
| 107 |
<Item> |
| 108 |
This is <Keyword>true</Keyword> in a list item. |
| 109 |
</Item> |
| 110 |
</List> |
| 111 |
<P/> |
| 112 |
All of this can <Emph>also</Emph> be <Emph>used</Emph> outside of a <Code>list</Code>. |
| 113 |
And fenced listings should keep would-be commands literal: |
| 114 |
<Listing><![CDATA[ |
| 115 |
@Section ThisMustStayLiteral |
| 116 |
#! AlsoLiteral |
| 117 |
]]></Listing> |
| 118 |
<Alt Only="LaTeX"><![CDATA[ |
| 119 |
This text will only appear in the \LaTeX version. |
| 120 |
]]></Alt> |
| 121 |
<Alt Only="LaTeX"><![CDATA[ |
| 122 |
This text will only appear in the \LaTeX version, too. |
| 123 |
]]></Alt> |
| 124 |
<Alt Not="LaTeX"><![CDATA[ |
| 125 |
This text will only appear in the HTML version and the text version. |
| 126 |
]]></Alt> |
| 127 |
<Alt Not="LaTeX"><![CDATA[ |
| 128 |
This text will only appear in the HTML version and the text version, too. |
| 129 |
]]></Alt> |
| 130 |
</Subsection> |
| 131 |
|
| 132 |
</Section> |
| 133 |
|
| 134 |
<Section Label="Chapter_SomeChapter_Section_Testing_various_kinds_of_documentation"> |
| 135 |
<Heading>Testing various kinds of documentation</Heading> |
| 136 |
|
| 137 |
<ManSection> |
| 138 |
<Filt Arg="arg" Type="Category" Name="SomeCategory" Label="for IsObject"/> |
| 139 |
<Returns><K>true</K> or <K>false</K> |
| 140 |
</Returns> |
| 141 |
<Description> |
| 142 |
A category |
| 143 |
</Description> |
| 144 |
</ManSection> |
| 145 |
|
| 146 |
<ManSection> |
| 147 |
<Filt Arg="arg" Type="Representation" Name="SomeRepresentation" Label="for IsAttributeStoringRep"/> |
| 148 |
<Returns><K>true</K> or <K>false</K> |
| 149 |
</Returns> |
| 150 |
<Description> |
| 151 |
A collection category over the category we just created; |
| 152 |
A collection category over the category we just created; |
| 153 |
A collection category over the category we just created; |
| 154 |
A representation |
| 155 |
</Description> |
| 156 |
</ManSection> |
| 157 |
|
| 158 |
<ManSection> |
| 159 |
<Attr Arg="arg" Name="SomeAttribute" Label="for IsGroup"/> |
| 160 |
<Description> |
| 161 |
An attribute |
| 162 |
</Description> |
| 163 |
</ManSection> |
| 164 |
|
| 165 |
<ManSection> |
| 166 |
<Prop Arg="arg" Name="SomeProperty" Label="for IsGroup"/> |
| 167 |
<Returns><K>true</K> or <K>false</K> |
| 168 |
</Returns> |
| 169 |
<Description> |
| 170 |
A property |
| 171 |
</Description> |
| 172 |
</ManSection> |
| 173 |
|
| 174 |
<ManSection> |
| 175 |
<Oper Arg="arg1,arg2" Name="SomeOperation" Label="for IsInt, IsGroup"/> |
| 176 |
<Description> |
| 177 |
An operation |
| 178 |
</Description> |
| 179 |
</ManSection> |
| 180 |
|
| 181 |
<ManSection> |
| 182 |
<Constr Arg="arg1,arg2" Name="SomeConstructor" Label="for IsGroup, IsInt"/> |
| 183 |
<Description> |
| 184 |
A cConstructor |
| 185 |
</Description> |
| 186 |
</ManSection> |
| 187 |
|
| 188 |
<ManSection> |
| 189 |
<Func Arg="arg" Name="SomeGlobalFunction" /> |
| 190 |
<Description> |
| 191 |
A global function |
| 192 |
</Description> |
| 193 |
</ManSection> |
| 194 |
|
| 195 |
<ManSection> |
| 196 |
<Var Name="SomeGlobalVariable" /> |
| 197 |
<Description> |
| 198 |
A global variable |
| 199 |
</Description> |
| 200 |
</ManSection> |
| 201 |
|
| 202 |
<ManSection> |
| 203 |
<Var Name="SomeGlobalName" /> |
| 204 |
<Description> |
| 205 |
A global name documented as a variable by default |
| 206 |
</Description> |
| 207 |
</ManSection> |
| 208 |
|
| 209 |
<ManSection> |
| 210 |
<Func Arg="x" Name="SomeGlobalNameFunction" /> |
| 211 |
<Description> |
| 212 |
A global name documented as a function once arguments are given |
| 213 |
</Description> |
| 214 |
</ManSection> |
| 215 |
|
| 216 |
<ManSection> |
| 217 |
<Filt Arg="arg" Name="SomeFilter" /> |
| 218 |
<Returns><K>true</K> or <K>false</K> |
| 219 |
</Returns> |
| 220 |
<Description> |
| 221 |
A filter |
| 222 |
</Description> |
| 223 |
</ManSection> |
| 224 |
|
| 225 |
<ManSection> |
| 226 |
<InfoClass Name="SomeInfoClass" /> |
| 227 |
<Description> |
| 228 |
An info class |
| 229 |
</Description> |
| 230 |
</ManSection> |
| 231 |
|
| 232 |
<ManSection> |
| 233 |
<Oper Arg="arg1,arg2" Name="SomeKeyDependentOperation" Label="for IsGroup, IsInt"/> |
| 234 |
<Description> |
| 235 |
A key dependent operation |
| 236 |
</Description> |
| 237 |
</ManSection> |
| 238 |
|
| 239 |
</Section> |
| 240 |
|
| 241 |
<Section Label="Chapter_SomeChapter_Section_Testing_the_group_commands"> |
| 242 |
<Heading>Testing the group commands</Heading> |
| 243 |
|
| 244 |
<ManSection Label="Group1"> |
| 245 |
<Heading>A family of operations</Heading> |
| 246 |
<Oper Arg="arg" Name="FirstOperation" Label="for IsInt"/> |
| 247 |
<Oper Arg="arg1,arg2" Name="SecondOperation" Label="for IsInt, IsGroup"/> |
| 248 |
<Oper Arg="arg1,arg2" Name="ThirdOperation" Label="for IsGroup, IsInt"/> |
| 249 |
<Description> |
| 250 |
First sentence. |
| 251 |
Second sentence. |
| 252 |
Third sentence. |
| 253 |
</Description> |
| 254 |
</ManSection> |
| 255 |
|
| 256 |
</Section> |
| 257 |
|
| 258 |
<Section Label="Chapter_SomeChapter_Section_Testing_chunks"> |
| 259 |
<Heading>Testing chunks</Heading> |
| 260 |
|
| 261 |
This test comes after the chunk is declared, but before it is inserted. |
| 262 |
<#Include Label="MyChunk"> |
| 263 |
The text "Hello, world." is inserted right before this. |
| 264 |
</Section> |
| 265 |
|
| 266 |
<Section Label="Chapter_SomeChapter_Section_Testing_code_chunks"> |
| 267 |
<Heading>Testing code chunks</Heading> |
| 268 |
|
| 269 |
This test comes after the code chunk is declared, but before it is inserted. |
| 270 |
<#Include Label="MyCode"> |
| 271 |
The text "Hello, world." is inserted right before this. |
| 272 |
</Section> |
| 273 |
|
| 274 |
</Chapter> |
| 275 |
|