From c655573f4a3c527743244dd4d7a1955b9d11f034 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Thu, 11 Apr 2024 13:50:50 +0200 Subject: [PATCH 1/6] move and rename hypothesis page --- .../extension.md => basic-features/hypothesis.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename book/{installation-and-setup/extension.md => basic-features/hypothesis.md} (100%) diff --git a/book/installation-and-setup/extension.md b/book/basic-features/hypothesis.md similarity index 100% rename from book/installation-and-setup/extension.md rename to book/basic-features/hypothesis.md From 7e415d362eb2933c0ebda557ba2c57b4a590f712 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Thu, 11 Apr 2024 14:08:22 +0200 Subject: [PATCH 2/6] update page --- book/basic-features/hypothesis.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/book/basic-features/hypothesis.md b/book/basic-features/hypothesis.md index dca2f8e..0332332 100644 --- a/book/basic-features/hypothesis.md +++ b/book/basic-features/hypothesis.md @@ -1,12 +1,12 @@ -# Making comments on the website +# Making comments on the website with Hypothesis -This section will explain how to use the extension hypothesis in order to make comments, an alternative is Utterances but this is only available for GitHub-hosted books. +Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension; an alternative is Utterances, but this is only available for GitHub-hosted books. Firstly, you will need to open your interactive text book in your browser. Take as example the [MUDE](https://mude.citg.tudelft.nl/book/intro.html) book. If you look at the top right of the page, you will see three icons, an arrow, an eye and a note-pad. Clicking on the arrow will open the extension. The extension we are currently using is called Hypothesis. In order to use it you will have to make an account. Through the extension you will be able to highlight relevant sections and write notes and annotations. Comments on the content of the book can be submitted by making annotations and posting them to group called Feedback! -## Set up hypothesis in your book +## Set up Hypothesis in your book Add this to `_config.yml`. Need to create an account. ``` @@ -19,4 +19,21 @@ html: :class: tip - use {ref}`remove_from_publish` to enable in Draft book only +``` + +## Using Hypothesis + +In this case it is easier to learn by doing! Hypothesis has been enabled for this book: click the small arrow at the top right of the page to view the annotations. Create an account and log in if you would like to reply or make your own annotations. You can also highlight text, but this is not publicly visible, it is only for your own reference. + +You can also see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). + +% THIS IS ADDED TO PAGE AS ANNOTATION: +% This is an example Annotation. Note that annotations are publicly visible, but you must create an account and be logged in to reply or make your own. You can make highlights, but they are only visible to you, not everyone. You can also see all the Annotations on a website by opening the "Public" menu at the top of this dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). + +```{admonition} Be careful of changing website URL's! +:class: warning + +Annotations created using the Hypothesis feature are linked to the specific URL of a website, so keep this in mind if you move a book, or change the file name, as you could lose track of your work! Note that while changing the URL may make a page invisible, you can still find the annotations using the _View group activity_ feature. + +For example, if there is no annotation visible on this page, the URL probably changed! ``` \ No newline at end of file From 6757e2a34511aa37f26e53e660397f39746f9c71 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Thu, 11 Apr 2024 14:09:02 +0200 Subject: [PATCH 3/6] set up config --- book/_config.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 6a3e5a7..6968c06 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -21,4 +21,8 @@ sphinx: - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js thebe_config: use_thebe_lite: true - exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] \ No newline at end of file + exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] + +html: + comments: + hypothesis: true \ No newline at end of file From 30d2b67d7a785d3810cd736827b8249dd9d5b68b Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Thu, 11 Apr 2024 14:10:40 +0200 Subject: [PATCH 4/6] content update --- book/basic-features/hypothesis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/basic-features/hypothesis.md b/book/basic-features/hypothesis.md index 0332332..4b6b082 100644 --- a/book/basic-features/hypothesis.md +++ b/book/basic-features/hypothesis.md @@ -25,7 +25,7 @@ html: In this case it is easier to learn by doing! Hypothesis has been enabled for this book: click the small arrow at the top right of the page to view the annotations. Create an account and log in if you would like to reply or make your own annotations. You can also highlight text, but this is not publicly visible, it is only for your own reference. -You can also see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). +Note that the annotations are only visible for the page that you are currently viewing. You can see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). % THIS IS ADDED TO PAGE AS ANNOTATION: % This is an example Annotation. Note that annotations are publicly visible, but you must create an account and be logged in to reply or make your own. You can make highlights, but they are only visible to you, not everyone. You can also see all the Annotations on a website by opening the "Public" menu at the top of this dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). From 99a5d6d80bbe54497836d08df8591a5a2c343b25 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Fri, 12 Apr 2024 16:41:12 +0200 Subject: [PATCH 5/6] update toc --- book/_toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_toc.yml b/book/_toc.yml index 9dc24c9..09e2012 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -30,7 +30,7 @@ parts: - file: basic-features/overview sections: - file: basic-features/recipes.md - - file: installation-and-setup/extension + - file: basic-features/hypothesis - file: features/overview sections: - file: features/remove_from_publish From a275e09af403ba46e81f425b467495f468901a2d Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Fri, 12 Apr 2024 16:51:29 +0200 Subject: [PATCH 6/6] update hypothesis text --- book/basic-features/hypothesis.md | 34 ++++++++++++++----------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/book/basic-features/hypothesis.md b/book/basic-features/hypothesis.md index 4b6b082..b5edb33 100644 --- a/book/basic-features/hypothesis.md +++ b/book/basic-features/hypothesis.md @@ -2,9 +2,22 @@ Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension; an alternative is Utterances, but this is only available for GitHub-hosted books. -Firstly, you will need to open your interactive text book in your browser. Take as example the [MUDE](https://mude.citg.tudelft.nl/book/intro.html) book. +## Using Hypothesis -If you look at the top right of the page, you will see three icons, an arrow, an eye and a note-pad. Clicking on the arrow will open the extension. The extension we are currently using is called Hypothesis. In order to use it you will have to make an account. Through the extension you will be able to highlight relevant sections and write notes and annotations. Comments on the content of the book can be submitted by making annotations and posting them to group called Feedback! +In this case it is easier to learn by doing! Hypothesis has been enabled for this book: if you look at the top right of the page, you will see three icons, an arrow, an eye and a note-pad. Clicking on the arrow will open the extension and allow you to view the annotations. Create an account and log in if you would like to reply or make your own annotations. You can also highlight text, but this is not publicly visible, it is only for your own reference. + +Note that the annotations are only visible for the page that you are currently viewing. You can see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). + +% THIS IS ADDED TO PAGE AS ANNOTATION: +% This is an example Annotation. Note that annotations are publicly visible, but you must create an account and be logged in to reply or make your own. You can make highlights, but they are only visible to you, not everyone. You can also see all the Annotations on a website by opening the "Public" menu at the top of this dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). + +```{admonition} Be careful of changing website URL's! +:class: warning + +Annotations created using the Hypothesis feature are linked to the specific URL of a website, so keep this in mind if you move a book, or change the file name, as you could lose track of your work! Note that while changing the URL may make a page invisible, you can still find the annotations using the _View group activity_ feature. + +For example, if there is no annotation visible on this page, the URL probably changed! +``` ## Set up Hypothesis in your book Add this to `_config.yml`. Need to create an account. @@ -19,21 +32,4 @@ html: :class: tip - use {ref}`remove_from_publish` to enable in Draft book only -``` - -## Using Hypothesis - -In this case it is easier to learn by doing! Hypothesis has been enabled for this book: click the small arrow at the top right of the page to view the annotations. Create an account and log in if you would like to reply or make your own annotations. You can also highlight text, but this is not publicly visible, it is only for your own reference. - -Note that the annotations are only visible for the page that you are currently viewing. You can see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). - -% THIS IS ADDED TO PAGE AS ANNOTATION: -% This is an example Annotation. Note that annotations are publicly visible, but you must create an account and be logged in to reply or make your own. You can make highlights, but they are only visible to you, not everyone. You can also see all the Annotations on a website by opening the "Public" menu at the top of this dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). - -```{admonition} Be careful of changing website URL's! -:class: warning - -Annotations created using the Hypothesis feature are linked to the specific URL of a website, so keep this in mind if you move a book, or change the file name, as you could lose track of your work! Note that while changing the URL may make a page invisible, you can still find the annotations using the _View group activity_ feature. - -For example, if there is no annotation visible on this page, the URL probably changed! ``` \ No newline at end of file