Skip to content

Commit

Permalink
README: change MathBook XML to PreTeXt in README files
Browse files Browse the repository at this point in the history
  • Loading branch information
davidfarmer committed Oct 30, 2021
1 parent 4ebf899 commit 3ad18a5
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Thanks for your interest in making PreTeXt better. Contributions from users are
* Use the [pretext-dev](https://groups.google.com/forum/#!forum/pretext-dev) Google Group to float your idea before starting. You will get some good feedback that will make your contribution better and you may get some cautions that will save you some effort.
* Pull requests on GitHub are the easiest way to contribute and are really the only practical way for us to review, test, and incorporate your work. If you are new to Git, there is lots of information on the Internet, and some of it is even helpful and accurate. You can also read a guide we put together, [Git for Authors](https://pretextbook.org/gfa/html/). Despite the title, it has general principles and techniques that work equally well for software.
* **Always** begin a new branch for a contribution. And keep topically distinct contributions on different branches. Small and compact is better than large and diverse.
* Pull frequently from the main line of development for official MathBook XML (`dev` at this writing) to update current progress. Then **rebase** your topic branch onto the tip of this official branch as you work.
* Pull frequently from the main line of development for official PreTeXt (`dev` at this writing) to update current progress. Then **rebase** your topic branch onto the tip of this official branch as you work.
```
git checkout dev
git pull origin dev
Expand Down
8 changes: 4 additions & 4 deletions COPYING
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Copyright 2013 Robert A. Beezer

This file is part of MathBook XML.
This file is part of PreTeXt.

MathBook XML is free software: you can redistribute it and/or modify
PreTeXt is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 or version 3 of the
License (at your option).

MathBook XML is distributed in the hope that it will be useful,
PreTeXt is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with MathBook XML. If not, see <http://www.gnu.org/licenses/>.
along with PreTeXt. If not, see <http://www.gnu.org/licenses/>.
2 changes: 1 addition & 1 deletion contrib/ups-writers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Compatibility layers to support extra features for discussing aspects of writing
* Colors to indicate parts of bibliography entries.
* A different ellipsis for text use.

First used Fall 2016. None of this should be taken as especially semantic, so is not a good example of the MathBook XML philosophy.
First used Fall 2016. None of this should be taken as especially semantic, so is not a good example of the PreTeXt philosophy.
12 changes: 6 additions & 6 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# MathBook XML Examples
# PreTeXt Examples

Some directories have their own `README`. This is an overview of the contents of the `examples/` directory, with the date of the last update for each entry.

For several of these, sample output (PDF, HTML) is produced routinely and is available at the MathBook XML website from the "Examples" page.
For several of these, sample output (PDF, HTML) is produced routinely and is available at the PreTeXt website from the "Examples" page.


### Sample Article (`sample-article/`)
Expand All @@ -22,12 +22,12 @@ A short article. This is a good place to test a problematic construction. This

### Hello, World (`hello-world/`)

The bare minimum, about as little as you can do and still be valid MathBook XML. (2016-02-20)
The bare minimum, about as little as you can do and still be valid PreTeXt. (2016-02-20)


### WeBWorK (`webwork/`)

Several examples of how to author WeBWorK online homework problems within a MathBook XML book. See the `Makefile` for guidance on how to build the examples. (2016-02-20)
Several examples of how to author WeBWorK online homework problems within a PreTeXt book. See the `Makefile` for guidance on how to build the examples. (2016-02-20)


### Braille (`braille/`)
Expand All @@ -37,7 +37,7 @@ A fairly simple document to test the conversion of principal elements of a docum

### Humanities in Action (`humanities/`)

Various exhibits of material authored in MathBook XML which might be of more interest to Humanities scholars. Initiated by Jahrme Risner during his Summer 2016 undergraduate research project. (2016-07-10)
Various exhibits of material authored in PreTeXt which might be of more interest to Humanities scholars. Initiated by Jahrme Risner during his Summer 2016 undergraduate research project. (2016-07-10)


### Characters, Fonts, and Languages (`fonts/`)
Expand All @@ -47,7 +47,7 @@ A testing and demonstration document similar to the sample article, but focused

### Pug (`pug`)

Pug (nee Jade) is a Javascript template engine, which can be employed easily to output MathBook XML source. So if you prefer to format with whitespace, this could be a good choice. "Normal" output is best, but using a `-P` flag provides better formatting of the XML output for human eyes. Contributed by Harald Schilly. (2016-05-21)
Pug (nee Jade) is a Javascript template engine, which can be employed easily to output PreTeXt source. So if you prefer to format with whitespace, this could be a good choice. "Normal" output is best, but using a `-P` flag provides better formatting of the XML output for human eyes. Contributed by Harald Schilly. (2016-05-21)

A subdirectory contains the original file for the Windows Installation Notes of the Author's Guide, contributed by Dave Rosoff. It needs a few fixes, and will not be maintained, but will give a good demonstration of how a substantial chunk of content could be authored with Pug. (2016-05-31)

Expand Down
4 changes: 2 additions & 2 deletions examples/epub/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# EPUB Conversion (Preliminary, 2016-05-19)

The `build.sh` BASH script shows how to use various tools to create the necessary files for an EPUB version of a MathBook XML `book`. A small uncomplicated test document is included, which does contain non-trivial mathematics and graphics.
The `build.sh` BASH script shows how to use various tools to create the necessary files for an EPUB version of a PreTeXt `book`. A small uncomplicated test document is included, which does contain non-trivial mathematics and graphics.

The `mathjax-node` program is a major pre-requisite. See the two different ways to employ it in the script. See `xsl/mathbook-epub.xsl` for a key component.
The `mathjax-node` program is a major pre-requisite. See the two different ways to employ it in the script. See `xsl/pretext-epub.xsl` for a key component.

Everything here is subject to change and possible relocation.

4 changes: 2 additions & 2 deletions examples/fonts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Characters, Fonts, and Languages

The `fonts-and-charcters.xml` document here is mostly
for testing the use of the `xelatex` LaTeX engine on
the output of `xsl\pretext-latex.html`. It should also
the output of `xsl/pretext-latex.html`. It should also
render well in HTML formats. With the `pdflatex` engine
it will produce numerous errors (partly by design).
it will produce numerous errors (partly by design).
2 changes: 1 addition & 1 deletion examples/minimal/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Minimal Example

`minimal.xml` is a one-page article that might be your first exercise in setting up PreTeXt.
`source/main.ptx` is a one-page article that might be your first exercise in setting up PreTeXt.
Look at the top of the file for instructions on processing the file into a variety of output formats
using `xsltproc` or the PreTeXt-CLI.
2 changes: 1 addition & 1 deletion examples/webwork/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# WeBWorK examples

These examples demonstrate how to author, and process, [WeBWorK](http://webwork.maa.org/) automated homework problems for inclusion in a [MathBook XML](https://pretextbook.org) document.
These examples demonstrate how to author, and process, [WeBWorK](http://webwork.maa.org/) automated homework problems for inclusion in a [PreTeXt](https://pretextbook.org) document.

Because the process can be a bit more involved when your document includes a WW problem, we provide a makefile to process the examples and as concrete documentation of how to process your own document.

Expand Down
2 changes: 1 addition & 1 deletion script/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ PreTeXt Script Directory
A stub replacing an obsolete script, which simply tries to
execute the `pretext/pretext` script. DO NOT USE.

`\braille`
`braille`
----------

Files for converting PreTeXt to Braille, see README there.
Expand Down

0 comments on commit 3ad18a5

Please sign in to comment.