External Contents Pages

Docs external toc

book/_toc.yml

@@ -61,7 +61,10 @@ parts:
       - file: external/deploy-book-workflow/README.md
       - file: features/pull_request_build.md
       - file: features/local_server
-      - file: external/Nested-Books/README.md
+      - file: features/external_toc
+        sections:
+        - file: external/Nested-Books/README.md
+          title: (Deprecated) Share content between books using submodules
       - file: features/update_env
       - file: features/versioning
     - file: features/sphinx_extensions.md

book/features/external_toc.md

@@ -0,0 +1,75 @@
+(external-toc)=
+# Sharing content between books in table of contents
+
+```{admonition} User types
+:class: tip
+This page is useful for user type 3-5.
+```
+
+{bdg-secondary}`Python Package: teachbooks`
+
+## Introduction
+
+When creating books, you might want to reuse material from other people or from other books you made. In some cases you might even want to have the exact same material into your book. You could do so by manually copying material over. However, whenever the source material is updated, you have to do that again. As an alternative, you can use the underlying git system to refer to the source file directly. This allows you to pick a specific version, or keep the most up-to-date version of it. This pages explains how to do so directly in the table of contents using the **External Content** (or **External TOC**) feature which is part of the TeachBooks Python package.
+
+Previously, this book feature was implemented using [submodules](../external/Nested-Books/README.md), but the implementation was more difficult to use. Despite this, submodules are still a widely used Git feature that can be very useful for book authors, so check out the [submodules page](../external/Nested-Books/README.md) to learn more, especially if the External TOC tool does not satisfy your needs. Submodules have a few additional features not (yet) implemented using the External TOC.
+
+```{warning}
+The External TOC features are not incorporated in the new deploy book workflow yet (this will happen once the workflow specifies `teachbooks>=0.2.0`).
+```
+
+## What does it do?
+
+This functionality, part of the [TeachBooks package](https://github.com/TeachBooks/TeachBooks) allows you to refer to `.ipynb`, `.md` and `.rst` files stored on public repositories. These files are then handles as if they were normal files in your book, leading to a the file as a page in your built book. To prevent issues it validates that the external content has a permissive license, automatically combines any `reference.bib` files, and warns you if there's a mismatch in `requirements.txt` or with plugins in `_config.yml`.
+
+## Installation
+To use this extenstion, follow these steps:
+
+**Step 1: Install the Package**
+
+Install the module `teachbooks` package using `pip`:
+```
+pip install teachbooks>=0.2.0
+```
+    
+**Step 2: Add to `requirements.txt`**
+
+Make sure that the package is included in your project's `requirements.txt` to track the dependency:
+```
+teachbooks>=0.2.0
+```
+
+## Usage
+
+To use the functionality, take the URL of a file and add it to your `_toc.yml` as follows:
+
+```yaml
+format: jb-book
+root: .
+
+parts:
+  - caption: ...
+    chapters:
+    - file: ...
+    .
+    .
+    .
+    - external: <link to GitHub / GitLab source .md or .ipynb file>
+    .
+    .
+    .
+```
+
+The link can be pointing to a file on a branch (which will take the most recent version of that file on the branch) or a commit or tag (which will take a specific version of the file). For example:
+- `external: https://github.com/TeachBooks/manual/blob/release/book/intro.md` will take the most recent version of the intro page of this book on the release branch
+- `external: https://github.com/TeachBooks/manual/blob/06d67e8a0110c94d9147ce07090656dedc7d0e64/README.md` will take the file during the state of a specific commit (06d67e8).
+- `external: https://github.com/TeachBooks/manual/blob/v1.1.1/README.md` will take the file during the state of a specific tag (v1.1.1)
+
+If you're building your book online in GitHub, the [deploy-book-workflow](../external/deploy-book-workflow/README.md) will deal with these files during the `teachbooks build` command. If you want to build the book locally, run the command `teachbooks build`.
+
+If the source file is from another book, the contents of the `requirements.txt`, `_config.yml` are checked for any missing/incompatible entries. If this leads to compatibility issue, you'll be warned during the build which will help you solve these dependencies or plugins manually by updating your main book's `_config.yml` and `requirements.txt`
+Additionally, any `references.bib` files are merged into your main book's `references.bib` file, and the licenses of the external content are validated to allow for re-use. External content without a permissive license will result in an error to try to prevent any accidental copyright infringement.
+
+## Contribute
+
+This tool's repository is stored on [GitHub](https://github.com/TeachBooks/TeachBooks). If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/TeachBooks).

book/features/local_server.md

@@ -6,7 +6,7 @@
 This section is useful for user type 4-5.
 ```
 
-{bdg-secondary}`Python Package`
+{bdg-secondary}`Python Package: teachbooks`
 
 Perhaps you have already noticed that when building a book and testing it locally on your computer, some features do not work the way you expect, or worse---do not work at all! This is because many interactive features rely on browser functionality to work properly, for example: Grasple/H5p iframe exercises, Sphinx-Thebe Python interactivity and HTML/Javascript elements. Although the website is _static_ (i.e., there is no code running on a webserver that generates the content), modern web browsers have their own internal computing environments that run processes to deliver the rich content we desire in our books.
 

book/features/overview.md

@@ -9,11 +9,11 @@ Since the list of TeachBook features is getting quite long, we have grouped them
 - Book styling
 - TeachBooks student-view features
 
-Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features:
+Additionally, not all features are built and shared in the same way. We do our best to make sure that as many tools as possible are included automatically when using our TeachBooks Template Book; if you are not using the Template, we try to make sure each of our tools can be used independently. For transparency, tags will help differentiate between the different backgrounds of the features:
 - {bdg-warning}`Javascript overlay`
 - {bdg-success}`Chrome Extension`
 - {bdg-white}`GitHub App and Javascript script`
-- {bdg-secondary}`Python Package`
+- {bdg-secondary}`Python Package: teachbooks`
 - {bdg-light}`GitHub Reusable Action`
 - {bdg-light}`GitHub Template`
 - {bdg-dark}`Git Workflow`

book/features/teachbooks.md

@@ -6,7 +6,7 @@
 This page is useful for user type 3-5.
 ```
 
-{bdg-secondary}`Python Package`
+{bdg-secondary}`Python Package: teachbooks`
 
 Often it is necessary to prepare, review and edit materials in parallel to material that is currently being used by students, or another target audience. This workflow enables an author to easily maintain separate versions of a book without having to repeatedly comment out lines of a table of contents or page when building different versions. It is also easy to implement in CI/CD settings (it is already implemented in the {ref}Deploy Book Workflow <deploy-book-workflow>`, which builds our TeachBooks).