Skip to content

Commit

Permalink
play towards HTML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jw-allen
jw-allen committed Nov 5, 2020
1 parent 7f21459 commit aa0f8e2
Show file tree
Hide file tree
Showing 24 changed files with 1,227 additions and 194 deletions.
20 changes: 10 additions & 10 deletions PackageInfo.g
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SetPackageInfo( rec(

Version := "v0.6.0",

Date := "23/07/2020",
Date := "05/11/2020",

License := "GPL-2.0-or-later",

Expand Down Expand Up @@ -51,25 +51,25 @@ SetPackageInfo( rec(
ArchiveFormats := ".tar.gz",

README_URL :=
Concatenation( ~.PackageWWWHome, "/README.md" ),
Concatenation( ~.PackageWWWHome, "/README" ),

PackageInfoURL :=
"https://github.com/jw-allen/sbstrips/blob/master/PackageInfo.g",

AbstractHTML :=
"The <span class=\"pkgname\">SBstrips</span> package models 'strings' -- \
the decorated graphs used in representation theory. These graphs are known \
to describe a type of module for a special biserial algebra called a string \
module. The syzygy of a string module is a direct sum of string modules; \
hence syzygy-taking is essentially a one-to-many operation on strings. \
<span class=\"pkgname\">SBstrips</span> package implements 'strings' as a \
data structure called 'strips', and performs this syzygy calculation.",
the decorated graphs used in representation theory. These graphs are known \
to describe a type of module for a special biserial algebra called a string \
module. The syzygy of a string module is a direct sum of string modules; \
hence syzygy-taking is essentially a one-to-many operation on strings. \
<span class=\"pkgname\">SBstrips</span> package implements 'strings' as a \
data structure called 'strips', and performs this syzygy calculation.",

PackageDoc := rec(
BookName := "sbstripsdoc",
BookName := "SBStrips",
ArchiveURLSubset := ["doc"],
HTMLStart := "doc/chap0.html",
PDFFile := "doc/sbstripsdoc.pdf",
PDFFile := "doc/manual.pdf",
SixFile := "doc/manual.six",
LongTitle := ~.Subtitle
),
Expand Down
52 changes: 52 additions & 0 deletions doc/chap0.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@


 SBStrips 


Version 0.6.0


Joe Allen



A discrete model of special biserial algebras, string
modules and their syzygies




-------------------------------------------------------
Abstract
We implement a discrete model of special biserial algebras and, more to the
point, their string modules. We represent string modules using new objects
that we call strips. Using these, we efficiently calculate syzygies of
string modules in terms of the strips that represent them.

This package builds on, an interfaces with, the QPA package. This package
was created as part of the author's PhD thesis.


-------------------------------------------------------
Copyright
Joe Allen © 2020


-------------------------------------------------------
Acknowledgements
I thank my PhD supervisor Professor Jeremy Rickard, on whom I inflicted
multiple early iterations of SBStrips, for his time and his comments. This
package was much worse before his feedback.


-------------------------------------------------------


Contents (SBStrips)

1 Introduction
1.1 Heading
1.1-1 InfoSBStrips



17 changes: 17 additions & 0 deletions doc/chap1.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

1 Introduction

This is based on [?LM04?].


1.1 Heading

1.1-1 InfoSBStrips

InfoSBStrips info class
Returns: nothing

The default value is 1. Set it to 2, 3 or 4 for increasing amounts of
verbiosity. Set it to 0 to receive no commentary from SBStrips about the
work it's doing.

7 changes: 7 additions & 0 deletions doc/chapBib.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@


References




8 changes: 8 additions & 0 deletions doc/chapInd.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@


Index

InfoSBStrips 1.1-1


-------------------------------------------------------
204 changes: 23 additions & 181 deletions doc/main.xml
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>

<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Documentation for the SBStrips package of GAP, written by Joe Allen as part +
+ of his PhD thesis. +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

<!DOCTYPE Book SYSTEM "gapdoc.dtd"
[ <!ENTITY fail "<K>fail</K>">
<!ENTITY false "<K>false</K>">
Expand All @@ -14,197 +9,44 @@
]
>

<?LaTeX ExtraPreamble="
\usepackage{amsmath}
\usepackage{tikz}
\usepackage{tikz-cd}
\tikzset{>=to}
\DeclareMathOperator{\add}{add}
"?>

<Book Name="SBStrips">

<!-- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ FRONTMATTER +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -->

<TitlePage>
<#Include Label="TitlePage">
</TitlePage>

<TableOfContents/>

<Body>
<!-- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ ABOVE THE SURFACE +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -->


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Introduction |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>Introduction</Heading>

<#Include Label="ChapIntroduction">
</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Worked example |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<Chapter>
<Heading>
Worked example
</Heading>

<#Include Label="ChapExample">
</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Strips and syzygies |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Strips
</Heading>

<#Include Label="ChapStripsSyzygies">
</Chapter>


<!-- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ UNDER THE SURFACE +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -->


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Discrete model for SB algebras and their string modules |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Discrete model for SB algebras and their string modules
</Heading>

<#Include Label="ChapDiscreteModel">

</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Quiver utilities and the overquiver of a SB algebra |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<Chapter>
<Heading>
Quiver utilities and the overquiver of a SB algebra
</Heading>

<#Include Label="ChapQuiverUtilitiesOverquiver">

</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Permissible data of a SB algebra |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Permissible data of a SB algebra
</Heading>

<#Include Label="ChapPermissibleData">
</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Vertex-indexed sequences and encodings of permissible data |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Vertex-indexed sequences and encodings of permissible data
</Heading>

<#Include Label="ChapVISEncodings">
</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Syllables |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Syllables
</Heading>

<#Include Label="ChapSyllables">
</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Patches |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Patches
</Heading>

<#Include Label="ChapPatches">
</Chapter>


<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Utilities |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<Chapter>
<Heading>
Utilities
</Heading>

<#Include Label="ChapUtilities">
This is based on <Cite Key="LM04"/>.

<Section>
<Heading>
Heading
</Heading>

<ManSection>
<InfoClass Name="InfoSBStrips"/>
<Returns>
nothing
</Returns>
<Description>
The default value is <M>1</M>. Set it to <M>2</M>, <M>3</M> or
<M>4</M> for increasing amounts of verbiosity. Set it to <M>0</M>
to receive no commentary from &SBStrips; about the work it's doing.
</Description>
</ManSection>

</Section>
</Chapter>

</Body>



<!-- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ APPENDICES +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -->

<Appendix>
<Heading>
Example algebras
</Heading>

<#Include Label="AppExampleAlgebras"/>
</Appendix>


<!-- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ BACKMATTER +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -->

<Bibliography Databases="sbstripsbib.xml" Style="alpha"/>

<TheIndex/>

</Book>
</Book>
Loading

0 comments on commit aa0f8e2

Please sign in to comment.