README.md

Documentation Directory

The docs directory contains LaTeX and related LaTeX support files for the Pronouns2 project.

Pre-Installed Files

LaTeX Support Files

• Pronouns2.bib - BibLaTeX references cited by Pronouns, Second Edition LaTeX files
• Pronouns2Macros.tex - LaTeX include file used by other LaTeX documents
• RelatedLiterature.bib - BibLaTeX references cited by RelatedLiterature.tex

Main Documentation

• Pronouns2Modula2.tex - Pronouns, Second Edition (Modula-2 Version)
• Pronouns2Python.tex - Pronouns, Second Edition (Python Version)
• RelatedLiterature.tex - Pronouns and Anaphora Related Literature Since 1980
• VaryingRho.tex - Varying Spreading Algorithm’s rho

Pre-built PDFs

• Demo.pdf - PDF built from Demo.tex
• Pronouns2Modula2.pdf - PDF built from Pronouns2Modula2.tex
• Pronouns2Python.pdf - PDF built from Pronouns2Python.tex
• RelatedLiterature.pdf - PDF built from RelatedLiterature.tex
• VaryingRho.pdf - PDF built from VaryingRho.tex

Generated Files

• Demo.tex - LaTeX source generated by doc(file_type=FileType.TEX)
• Demo.txt - Text source generated by doc(file_type=FileType.TXT)

Make Commands

The following make targets are available:

• make help - Print this help
• make view - Build everything; view Demo.pdf
• make all - Process all LaTeX files in directory (except Pronouns2Macros.tex)
• make xxx - Process specific file (e.g., 'make Pronouns2Python')
• make xxx.pdf - Same as above, will process xxx.tex
• make clean - Remove intermediate LaTeX files
• make distclean - Remove all generated files except shipping PDFs
• make maintainer-clean - Remove all generated files, including shipping PDFs

LaTeX Processing

The build system automatically detects two types of LaTeX files:

1. Simple files (processed with single pdflatex run)
2. Complex files with bibliography/index (processed with multiple tools)

Note:

• Pronouns2Macros.tex is an include file and cannot be processed directly
• .txt and .bib files are pre-built and cannot be processed

Software Requirements

Recreating *.pdf from *.tex requires:

• MikTeX 22.1 or compatible
• pdflatex 4.10.0 or compatible
• biber 2.20 or compatible
• makeindex 2.12 or compatible

Required LaTeX packages (managed by MikTeX):

• bm
• imakeidx
• bookmark
• courier
• indentfirst
• inputenc
• tikz-cd
• biblatex (with biber backend)
• setspace

HTML Documentation

If you're looking for:

• HTML documentation: src/docs/build/html/index.htm
• Information about generating HTML documentation: src/docs/README.md.