From e41711f6a601b916cf9da72fcdca7cfb0e6644fe Mon Sep 17 00:00:00 2001 From: Steven Clontz Date: Wed, 2 Jun 2021 20:50:47 +0000 Subject: [PATCH] 0.2rc0 release --- docs/about.html | 61 +++--- docs/contributors.html | 84 ++++++++ docs/index.html | 2 +- docs/installation.html | 93 +++++---- docs/knowl/aside-1.html | 2 +- docs/knowl/li-1.html | 2 +- docs/knowl/li-2.html | 2 +- docs/knowl/li-3.html | 2 +- docs/knowl/li-4.html | 2 +- docs/knowl/li-5.html | 2 +- docs/knowl/li-6.html | 4 +- docs/knowl/li-7.html | 4 +- docs/knowl/li-8.html | 22 +++ docs/knowl/li-9.html | 22 +++ docs/knowl/p-1.html | 2 +- docs/knowl/p-10.html | 4 +- docs/knowl/p-11.html | 4 +- docs/knowl/p-12.html | 4 +- docs/knowl/p-13.html | 4 +- docs/knowl/p-14.html | 4 +- docs/knowl/p-15.html | 4 +- docs/knowl/p-16.html | 4 +- docs/knowl/p-17.html | 4 +- docs/knowl/p-18.html | 6 +- docs/knowl/p-19.html | 2 +- docs/knowl/p-2.html | 2 +- docs/knowl/p-20.html | 21 ++ docs/knowl/p-21.html | 21 ++ docs/knowl/p-3.html | 2 +- docs/knowl/p-4.html | 2 +- docs/knowl/p-5.html | 2 +- docs/knowl/p-6.html | 2 +- docs/knowl/p-7.html | 2 +- docs/knowl/p-8.html | 2 +- docs/knowl/p-9.html | 4 +- docs/pretext-cli-documentation.html | 61 +++--- docs/usage.html | 290 ++++++++++++++-------------- pretext/static/help.txt | 223 ++++++++++----------- 38 files changed, 567 insertions(+), 413 deletions(-) create mode 100644 docs/contributors.html create mode 100644 docs/knowl/li-8.html create mode 100644 docs/knowl/li-9.html create mode 100644 docs/knowl/p-20.html create mode 100644 docs/knowl/p-21.html diff --git a/docs/about.html b/docs/about.html index 9662d07e..927d0af0 100644 --- a/docs/about.html +++ b/docs/about.html @@ -1,7 +1,7 @@ - + @@ -14,36 +14,29 @@ About - @@ -57,7 +50,7 @@ -Skip to main content

diff --git a/docs/contributors.html b/docs/contributors.html new file mode 100644 index 00000000..0ec231b4 --- /dev/null +++ b/docs/contributors.html @@ -0,0 +1,84 @@ + + + + + + + + + + + +Contributors + + + + + + + + + + + + + + + +Skip to main content +
+
+ +

+Chapter 1 Contributors +

+
+ + diff --git a/docs/index.html b/docs/index.html index 4ba5186a..3cd9200e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - + diff --git a/docs/installation.html b/docs/installation.html index 3fe8439a..a17dcea3 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -1,7 +1,7 @@ - + @@ -14,36 +14,29 @@ Installation - @@ -57,7 +50,7 @@ -Skip to main content

@@ -103,9 +98,9 @@

PreTeXt-CLI requires Python version 3.6 or better.

To check your version, type this into your terminal or command prompt:

-
python -V
+
python -V

If your version is 2.x, try this instead (and if so, either replace all future references to `python` in these instructions with `python3`, or try this).

-
python3 -V
+
python3 -V

If you don't have a compatible Python available, try one of these:

+

Then close and reopen your command line and try pretext --helpagain.

Subsection 2.4 Upgrading

-

The most recent version of PreTeXt-CLI is 0.1.3. Use pretext --version to see the version you're running.

-

To upgrade your version, run the following:

-
python -m pip install --user pretextbook --upgrade

+

The most recent version of PreTeXt-CLI is 0.2rc0 . Use pretext --version to see the version you're running.

+

To upgrade your version, run the following:

+
python -m pip install --user pretextbook --upgrade
diff --git a/docs/knowl/aside-1.html b/docs/knowl/aside-1.html index af1d1ba7..f9337371 100644 --- a/docs/knowl/aside-1.html +++ b/docs/knowl/aside-1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/li-1.html b/docs/knowl/li-1.html index 4a0172ec..dd1bc099 100644 --- a/docs/knowl/li-1.html +++ b/docs/knowl/li-1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/li-2.html b/docs/knowl/li-2.html index f3c6f2c4..fa2599a9 100644 --- a/docs/knowl/li-2.html +++ b/docs/knowl/li-2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/li-3.html b/docs/knowl/li-3.html index c9740b32..92309902 100644 --- a/docs/knowl/li-3.html +++ b/docs/knowl/li-3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/li-4.html b/docs/knowl/li-4.html index 5bce9008..176e2ac5 100644 --- a/docs/knowl/li-4.html +++ b/docs/knowl/li-4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/li-5.html b/docs/knowl/li-5.html index 01c86777..f41bdedf 100644 --- a/docs/knowl/li-5.html +++ b/docs/knowl/li-5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/li-6.html b/docs/knowl/li-6.html index 1860ec3e..d35ba591 100644 --- a/docs/knowl/li-6.html +++ b/docs/knowl/li-6.html @@ -2,7 +2,7 @@ - + @@ -18,7 +18,7 @@ Item.

To fix this on Linux/Mac, run the following commands:

-
+
 echo "export PATH=\"`python -m site --user-base`/bin:$PATH\"" >> ~/.bash_profile
 echo "export PATH=\"`python -m site --user-base`/bin:$PATH\"" >> ~/.zprofile
         
in-context diff --git a/docs/knowl/li-7.html b/docs/knowl/li-7.html index 3e0816a6..11778696 100644 --- a/docs/knowl/li-7.html +++ b/docs/knowl/li-7.html @@ -2,7 +2,7 @@ - + @@ -19,6 +19,6 @@

To fix this on Windows, open your Windows Control Panel, search for “environment”, and select “Edit environment variables for your account”

Then edit your PATH variable and add the following line (replacing 3x with the version of Python you installed, e.g. 38 for version 3.8):

-
%USERPROFILE%\AppData\Roaming\Python\Python3x\Scripts
in-context +
%USERPROFILE%\AppData\Roaming\Python\Python3x\Scripts
in-context diff --git a/docs/knowl/li-8.html b/docs/knowl/li-8.html new file mode 100644 index 00000000..bef9779a --- /dev/null +++ b/docs/knowl/li-8.html @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + +in-context + + diff --git a/docs/knowl/li-9.html b/docs/knowl/li-9.html new file mode 100644 index 00000000..74795a69 --- /dev/null +++ b/docs/knowl/li-9.html @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + +in-context + + diff --git a/docs/knowl/p-1.html b/docs/knowl/p-1.html index 72f495df..552b7087 100644 --- a/docs/knowl/p-1.html +++ b/docs/knowl/p-1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-10.html b/docs/knowl/p-10.html index c046af97..5b2d0545 100644 --- a/docs/knowl/p-10.html +++ b/docs/knowl/p-10.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

After installation, if you didn't see an error like “WARNING: The script pretext is installed in '[file_path]' which is not on PATH.”, then try to run:

+

It's also possible you may get an error like error: invalid command 'bdist_wheel' — good news, you can ignore it!).

in-context diff --git a/docs/knowl/p-11.html b/docs/knowl/p-11.html index 5aa4c8ce..fe75ea75 100644 --- a/docs/knowl/p-11.html +++ b/docs/knowl/p-11.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

If that works, great! Otherwise, it likely means that Python packages aren't available on your “PATH”.

+

After installation, if you didn't see an error like “WARNING: The script pretext is installed in '[file_path]' which is not on PATH.”, then try to run:

in-context diff --git a/docs/knowl/p-12.html b/docs/knowl/p-12.html index 504925b4..bc03f015 100644 --- a/docs/knowl/p-12.html +++ b/docs/knowl/p-12.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

To fix this on Linux/Mac, run the following commands:

+

If that works, great! Otherwise, it likely means that Python packages aren't available on your “PATH”.

in-context diff --git a/docs/knowl/p-13.html b/docs/knowl/p-13.html index b048c5e9..1808dede 100644 --- a/docs/knowl/p-13.html +++ b/docs/knowl/p-13.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

To fix this on Windows, open your Windows Control Panel, search for “environment”, and select “Edit environment variables for your account”

+

To fix this on Linux/Mac, run the following commands:

in-context diff --git a/docs/knowl/p-14.html b/docs/knowl/p-14.html index 028fa9b4..0fcfd3aa 100644 --- a/docs/knowl/p-14.html +++ b/docs/knowl/p-14.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

Then edit your PATH variable and add the following line (replacing 3x with the version of Python you installed, e.g. 38 for version 3.8):

+

To fix this on Windows, open your Windows Control Panel, search for “environment”, and select “Edit environment variables for your account”

in-context diff --git a/docs/knowl/p-15.html b/docs/knowl/p-15.html index 82dd70ba..a278f575 100644 --- a/docs/knowl/p-15.html +++ b/docs/knowl/p-15.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

Then close and reopen your command line and try pretext --helpagain.

+

Then edit your PATH variable and add the following line (replacing 3x with the version of Python you installed, e.g. 38 for version 3.8):

in-context diff --git a/docs/knowl/p-16.html b/docs/knowl/p-16.html index f382b69c..d4f9215a 100644 --- a/docs/knowl/p-16.html +++ b/docs/knowl/p-16.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

The most recent version of PreTeXt-CLI is 0.1.3. Use pretext --version to see the version you're running.

+

Then close and reopen your command line and try pretext --helpagain.

in-context diff --git a/docs/knowl/p-17.html b/docs/knowl/p-17.html index 7f9bccdd..48660b45 100644 --- a/docs/knowl/p-17.html +++ b/docs/knowl/p-17.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

To upgrade your version, run the following:

+

The most recent version of PreTeXt-CLI is 0.2rc0 . Use pretext --version to see the version you're running.

in-context diff --git a/docs/knowl/p-18.html b/docs/knowl/p-18.html index 4eaeeeaf..8613f917 100644 --- a/docs/knowl/p-18.html +++ b/docs/knowl/p-18.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

For your convenience, documentation on using all features of the command-line interface may be viewed below, or displayed on the command line by using the --help option. Use pretext --help to see what commands are available, and (for example) pretext new --help to learn how to use each command.

-in-context +

To upgrade your version, run the following:

+in-context diff --git a/docs/knowl/p-19.html b/docs/knowl/p-19.html index 74a92ea6..313e7fdc 100644 --- a/docs/knowl/p-19.html +++ b/docs/knowl/p-19.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-2.html b/docs/knowl/p-2.html index d0182be6..9505f176 100644 --- a/docs/knowl/p-2.html +++ b/docs/knowl/p-2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-20.html b/docs/knowl/p-20.html new file mode 100644 index 00000000..cf6138a9 --- /dev/null +++ b/docs/knowl/p-20.html @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + +
Paragraph
+

The development of PreTeXt's core is led by Rob Beezer.

+in-context + + diff --git a/docs/knowl/p-21.html b/docs/knowl/p-21.html new file mode 100644 index 00000000..c239cfb6 --- /dev/null +++ b/docs/knowl/p-21.html @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + +
Paragraph
+

For your convenience, documentation on using all features of the command-line interface may be viewed below, or displayed on the command line by using the --help option. Use pretext --help to see what commands are available, and (for example) pretext new --help to learn how to use each command.

+in-context + + diff --git a/docs/knowl/p-3.html b/docs/knowl/p-3.html index 9c955346..e3b61483 100644 --- a/docs/knowl/p-3.html +++ b/docs/knowl/p-3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-4.html b/docs/knowl/p-4.html index 2e852e5d..efcadea7 100644 --- a/docs/knowl/p-4.html +++ b/docs/knowl/p-4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-5.html b/docs/knowl/p-5.html index 7ff2bbba..647c0fff 100644 --- a/docs/knowl/p-5.html +++ b/docs/knowl/p-5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-6.html b/docs/knowl/p-6.html index 0b6ef525..bd184b2c 100644 --- a/docs/knowl/p-6.html +++ b/docs/knowl/p-6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-7.html b/docs/knowl/p-7.html index 36ebb64e..6b9cb943 100644 --- a/docs/knowl/p-7.html +++ b/docs/knowl/p-7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-8.html b/docs/knowl/p-8.html index c11a397a..ac4f1758 100644 --- a/docs/knowl/p-8.html +++ b/docs/knowl/p-8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/knowl/p-9.html b/docs/knowl/p-9.html index ee71b820..b4a45f15 100644 --- a/docs/knowl/p-9.html +++ b/docs/knowl/p-9.html @@ -2,7 +2,7 @@ - + @@ -15,7 +15,7 @@
Paragraph
-

(It's possible you may get an error like error: invalid command 'bdist_wheel' — good news, you can ignore it!)

+

If you get an error such as No module named pip. then install pip.

in-context diff --git a/docs/pretext-cli-documentation.html b/docs/pretext-cli-documentation.html index 82a03087..c301efae 100644 --- a/docs/pretext-cli-documentation.html +++ b/docs/pretext-cli-documentation.html @@ -1,7 +1,7 @@ - + @@ -14,36 +14,29 @@ PreTeXt-CLI Documentation - @@ -57,7 +50,7 @@ -Skip to main content

Section 3 Usage

-

For your convenience, documentation on using all features of the command-line interface may be viewed below, or displayed on the command line by using the --help option. Use pretext --help to see what commands are available, and (for example) pretext new --help to learn how to use each command.

-
Usage: pretext [OPTIONS] COMMAND [ARGS]...

-

-  Command line tools for quickly creating, authoring, and building PreTeXt

-  documents.

-

-Options:

-  -v, --verbose  -v for basic feedback; -vv for debug info

-  --version      Show the version and exit.

-  --help         Show this message and exit.

-

-Commands:

-  build    Build specified format target

-  new      Provision a new PreTeXt document.

-  publish  Prepares project for publishing on GitHub Pages.

-  view     Preview built PreTeXt documents in your browser.

-
-
--------------------------------------------------------------------------------
-
-Usage: pretext new [OPTIONS] [TITLE]

-

-  Creates a subdirectory with the files needed to author a PreTeXt document.

-

-  Usage: pretext new "My Great Book!"

-

-Options:

-  --directory PATH   Directory to create/use for the project. Defaults to a

-                     subdirectory of the current path based on book title.

-

-  --chapter TEXT     Provide one or more chapter titles.

-  -i, --interactive  Interactively requests names of book chapters.

-  --help             Show this message and exit.

-
-
--------------------------------------------------------------------------------
-
-Usage: pretext build [OPTIONS] [[html|latex|all]]

-

-  Process PreTeXt files into specified format.

-

-  For html, images coded in source (latex-image, etc) are only processed

-  using the --diagrams option.

-

-  If the project included WeBWorK exercises, these must be processed using

-  the --webwork option.

-

-Options:

-  -i, --input PATH      Path to main *.ptx file  [default: source/main.ptx]

-  -o, --output PATH     Path to main output directory  [default: output]

-  -p, --publisher PATH  Publisher file name, with path relative to base folder

-  --param TEXT          Define a stringparam to use during processing. Usage:

-                        pretext build --param foo:bar --param baz:woo

-

-  -d, --diagrams        Regenerate images coded in source (latex-image, etc)

-                        using pretext script

-

-  -w, --webwork         Reprocess WeBWorK exercises, creating fresh webwork-

-                        representations.ptx file

-

-  --config FILE         Read options from configuration FILE specified.

-                        [default: .ptxconfig]  Use `--config None` to run with

-                        standard default options.

-

-  -sc, --save-config    save any options provided to local configuration file,

-                        specified with --config (or default ".ptxconfig")

-

-  --help                Show this message and exit.

-
-
--------------------------------------------------------------------------------
-
-Usage: pretext view [OPTIONS]

-

-  Starts a local server to preview built PreTeXt documents in your browser.

-

-Options:

-  --directory PATH                Directory containing built PreTeXt

-                                  documents.  [default: output]

-

-  --access [public|private|cocalc]

-                                  Choose whether or not to allow other

-                                  computers on your local network to access

-                                  your documents using your IP address, with

-                                  special option to support CoCalc.com users.

-                                  [default: private]

-

-  --port INTEGER                  Choose which port to use for the local

-                                  server.  [default: 8000]

-

-  --config FILE                   Read options from configuration FILE

-                                  specified.  [default: .ptxconfig]  Use

-                                  `--config None` to run with standard default

-                                  options.

-

-  -sc, --save-config              save any options provided to local

-                                  configuration file, specified with --config

-                                  (or default ".ptxconfig")

-

-  --help                          Show this message and exit.

-
-
--------------------------------------------------------------------------------
-
-Usage: pretext publish [OPTIONS]

-

-  Prepares the project locally for HTML publication on GitHub Pages to make

-  the built document available to the general public. Only supports the

-  default `output/html` build directory. Requires Git and a GitHub account.

-

-Options:

-  --help  Show this message and exit.

-
+

For your convenience, documentation on using all features of the command-line interface may be viewed below, or displayed on the command line by using the --help option. Use pretext --help to see what commands are available, and (for example) pretext new --help to learn how to use each command.

+Subsection 3.1 pretext --help Output +

+
Usage: pretext [OPTIONS] COMMAND [ARGS]...
+
+  Command line tools for quickly creating, authoring, and building PreTeXt
+  documents.
+
+Options:
+  --silent   suppress basic feedback
+  --verbose  show debug info
+  --version  Show the version and exit.
+  --help     Show this message and exit.
+
+Commands:
+  build    Build specified format target
+  new      Provision a new PreTeXt document.
+  publish  Prepares project for publishing on GitHub Pages.
+  view     Preview built PreTeXt documents in your browser.
+
+
+-------------------------------------------------------------------------------
+
+Usage: pretext new [OPTIONS] [TITLE]
+
+  Creates a subdirectory with the files needed to author a PreTeXt document.
+
+  Usage: pretext new "My Great Book!"
+
+Options:
+  --directory PATH   Directory to create/use for the project. Defaults to a
+                     subdirectory of the current path based on book title.
+  --chapter TEXT     Provide one or more chapter titles.
+  -i, --interactive  Interactively requests names of book chapters.
+  --help             Show this message and exit.
+
+
+-------------------------------------------------------------------------------
+
+Usage: pretext build [OPTIONS] [[html|latex|diagrams|all]]
+
+  Process PreTeXt files into specified format.
+
+  For html, images coded in source (latex-image, etc) are only processed using
+  the --diagrams option.
+
+  If the project included WeBWorK exercises, these must be processed using the
+  --webwork option.
+
+Options:
+  -i, --input PATH                Path to main *.ptx file  [default:
+                                  source/main.ptx]
+  -o, --output PATH               Path to main output directory  [default:
+                                  output]
+  -p, --publisher PATH            Publisher file name, with path relative to
+                                  base folder
+  --param TEXT                    Define a stringparam to use during
+                                  processing. Usage: pretext build --param
+                                  foo:bar --param baz:woo
+  -d, --diagrams                  Regenerate images coded in source (latex-
+                                  image, etc) using pretext script
+  -df, --diagrams-format [svg|pdf|eps|tex]
+                                  Specify output format for generated images
+                                  (svg, png, etc).
+  -w, --webwork                   Reprocess WeBWorK exercises, creating fresh
+                                  webwork-representations.ptx file
+  --pdf                           Compile LaTeX output to PDF using
+                                  commandline pdflatex
+  --config FILE                   Read options from configuration FILE
+                                  specified.  [default: .ptxconfig]  Use
+                                  `--config None` to run with standard default
+                                  options.
+  -sc, --save-config              save any options provided to local
+                                  configuration file, specified with --config
+                                  (or default ".ptxconfig")
+  --help                          Show this message and exit.
+
+
+-------------------------------------------------------------------------------
+
+Usage: pretext view [OPTIONS]
+
+  Starts a local server to preview built PreTeXt documents in your browser.
+
+Options:
+  --directory PATH                Directory containing built PreTeXt
+                                  documents.  [default: output]
+  --access [public|private|cocalc]
+                                  Choose whether or not to allow other
+                                  computers on your local network to access
+                                  your documents using your IP address, with
+                                  special option to support CoCalc.com users.
+                                  [default: private]
+  --port INTEGER                  Choose which port to use for the local
+                                  server.  [default: 8000]
+  --config FILE                   Read options from configuration FILE
+                                  specified.  [default: .ptxconfig]  Use
+                                  `--config None` to run with standard default
+                                  options.
+  -sc, --save-config              save any options provided to local
+                                  configuration file, specified with --config
+                                  (or default ".ptxconfig")
+  --help                          Show this message and exit.
+
+
+-------------------------------------------------------------------------------
+
+Usage: pretext publish [OPTIONS]
+
+  Prepares the project locally for HTML publication on GitHub Pages to make
+  the built document available to the general public. Only supports the
+  default `output/html` build directory. Requires Git and a GitHub account.
+
+Options:
+  --help  Show this message and exit.
+
diff --git a/pretext/static/help.txt b/pretext/static/help.txt index 3114d4b2..6ea0f2b8 100644 --- a/pretext/static/help.txt +++ b/pretext/static/help.txt @@ -1,111 +1,112 @@ -Usage: pretext [OPTIONS] COMMAND [ARGS]... - - Command line tools for quickly creating, authoring, and building PreTeXt - documents. - -Options: - -v, --verbose -v for basic feedback; -vv for debug info - --version Show the version and exit. - --help Show this message and exit. - -Commands: - build Build specified format target - new Provision a new PreTeXt document. - publish Prepares project for publishing on GitHub Pages. - view Preview built PreTeXt documents in your browser. - - -------------------------------------------------------------------------------- - -Usage: pretext new [OPTIONS] [TITLE] - - Creates a subdirectory with the files needed to author a PreTeXt document. - - Usage: pretext new "My Great Book!" - -Options: - --directory PATH Directory to create/use for the project. Defaults to a - subdirectory of the current path based on book title. - - --chapter TEXT Provide one or more chapter titles. - -i, --interactive Interactively requests names of book chapters. - --help Show this message and exit. - - -------------------------------------------------------------------------------- - -Usage: pretext build [OPTIONS] [[html|latex|all]] - - Process PreTeXt files into specified format. - - For html, images coded in source (latex-image, etc) are only processed - using the --diagrams option. - - If the project included WeBWorK exercises, these must be processed using - the --webwork option. - -Options: - -i, --input PATH Path to main *.ptx file [default: source/main.ptx] - -o, --output PATH Path to main output directory [default: output] - -p, --publisher PATH Publisher file name, with path relative to base folder - --param TEXT Define a stringparam to use during processing. Usage: - pretext build --param foo:bar --param baz:woo - - -d, --diagrams Regenerate images coded in source (latex-image, etc) - using pretext script - - -w, --webwork Reprocess WeBWorK exercises, creating fresh webwork- - representations.ptx file - - --config FILE Read options from configuration FILE specified. - [default: .ptxconfig] Use `--config None` to run with - standard default options. - - -sc, --save-config save any options provided to local configuration file, - specified with --config (or default ".ptxconfig") - - --help Show this message and exit. - - -------------------------------------------------------------------------------- - -Usage: pretext view [OPTIONS] - - Starts a local server to preview built PreTeXt documents in your browser. - -Options: - --directory PATH Directory containing built PreTeXt - documents. [default: output] - - --access [public|private|cocalc] - Choose whether or not to allow other - computers on your local network to access - your documents using your IP address, with - special option to support CoCalc.com users. - [default: private] - - --port INTEGER Choose which port to use for the local - server. [default: 8000] - - --config FILE Read options from configuration FILE - specified. [default: .ptxconfig] Use - `--config None` to run with standard default - options. - - -sc, --save-config save any options provided to local - configuration file, specified with --config - (or default ".ptxconfig") - - --help Show this message and exit. - - -------------------------------------------------------------------------------- - -Usage: pretext publish [OPTIONS] - - Prepares the project locally for HTML publication on GitHub Pages to make - the built document available to the general public. Only supports the - default `output/html` build directory. Requires Git and a GitHub account. - -Options: - --help Show this message and exit. +Usage: pretext [OPTIONS] COMMAND [ARGS]... + + Command line tools for quickly creating, authoring, and building PreTeXt + documents. + +Options: + --silent suppress basic feedback + --verbose show debug info + --version Show the version and exit. + --help Show this message and exit. + +Commands: + build Build specified format target + new Provision a new PreTeXt document. + publish Prepares project for publishing on GitHub Pages. + view Preview built PreTeXt documents in your browser. + + +------------------------------------------------------------------------------- + +Usage: pretext new [OPTIONS] [TITLE] + + Creates a subdirectory with the files needed to author a PreTeXt document. + + Usage: pretext new "My Great Book!" + +Options: + --directory PATH Directory to create/use for the project. Defaults to a + subdirectory of the current path based on book title. + --chapter TEXT Provide one or more chapter titles. + -i, --interactive Interactively requests names of book chapters. + --help Show this message and exit. + + +------------------------------------------------------------------------------- + +Usage: pretext build [OPTIONS] [[html|latex|diagrams|all]] + + Process PreTeXt files into specified format. + + For html, images coded in source (latex-image, etc) are only processed using + the --diagrams option. + + If the project included WeBWorK exercises, these must be processed using the + --webwork option. + +Options: + -i, --input PATH Path to main *.ptx file [default: + source/main.ptx] + -o, --output PATH Path to main output directory [default: + output] + -p, --publisher PATH Publisher file name, with path relative to + base folder + --param TEXT Define a stringparam to use during + processing. Usage: pretext build --param + foo:bar --param baz:woo + -d, --diagrams Regenerate images coded in source (latex- + image, etc) using pretext script + -df, --diagrams-format [svg|pdf|eps|tex] + Specify output format for generated images + (svg, png, etc). + -w, --webwork Reprocess WeBWorK exercises, creating fresh + webwork-representations.ptx file + --pdf Compile LaTeX output to PDF using + commandline pdflatex + --config FILE Read options from configuration FILE + specified. [default: .ptxconfig] Use + `--config None` to run with standard default + options. + -sc, --save-config save any options provided to local + configuration file, specified with --config + (or default ".ptxconfig") + --help Show this message and exit. + + +------------------------------------------------------------------------------- + +Usage: pretext view [OPTIONS] + + Starts a local server to preview built PreTeXt documents in your browser. + +Options: + --directory PATH Directory containing built PreTeXt + documents. [default: output] + --access [public|private|cocalc] + Choose whether or not to allow other + computers on your local network to access + your documents using your IP address, with + special option to support CoCalc.com users. + [default: private] + --port INTEGER Choose which port to use for the local + server. [default: 8000] + --config FILE Read options from configuration FILE + specified. [default: .ptxconfig] Use + `--config None` to run with standard default + options. + -sc, --save-config save any options provided to local + configuration file, specified with --config + (or default ".ptxconfig") + --help Show this message and exit. + + +------------------------------------------------------------------------------- + +Usage: pretext publish [OPTIONS] + + Prepares the project locally for HTML publication on GitHub Pages to make + the built document available to the general public. Only supports the + default `output/html` build directory. Requires Git and a GitHub account. + +Options: + --help Show this message and exit.