From f361a639830cb534f9a92616af174c6212ccdd8b Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 28 Feb 2025 09:04:45 +0100 Subject: [PATCH] Update external_toc.md --- book/features/external_toc.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/book/features/external_toc.md b/book/features/external_toc.md index 04d75d6..7434e37 100644 --- a/book/features/external_toc.md +++ b/book/features/external_toc.md @@ -9,7 +9,9 @@ This page is useful for user type 3-5. {bdg-secondary}`Python Package` ## 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 TeachBooks package. Previously, this was implemented using [submodules] (../external/Nested-Books/README.md), but this implementation is more difficult to use. +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 TeachBooks package. + +Previously, this was implemented using [submodules] (../external/Nested-Books/README.md), but this implementation was more difficult to use. However, the approach using submodules allows to embed pages which: refer to content in the `_static` folder of the other book, include local images referenced with raw-HTML code, are part of a private book. Furthermore, if you'd like to be notified on updates of the other book, the approach using submodules allows notifications in any case, while the approach described on this page only allows for notifications by 'watching' the other book repository and requiring the other repo owner to release new version with 'releases'. ## What does it do? @@ -64,4 +66,4 @@ If the source file is from another book, the contents of the `requirements.txt`, ## 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). \ No newline at end of file +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).