admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Combined two pages on hypothesis

Browse source
This commit is contained in:
Tom van Woudenberg 2024-04-10 16:39:27 +02:00
parent 4fa2a4f518
commit cc44a4ab1e
2 changed files with 16 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

19
book/features/hypothesis.md
View file

@ -1,19 +0,0 @@
# Hypothesis
Add this to `_config.yml`. Need to create an account.
```
html:
comments:
hypothesis: true
```
```{admonition} Tips
:class: tip
- use {ref}`remove_from_publish` to enable in Draft book only
- figure out how to use this...
```

17
book/installation-and-setup/extension.md
View file

@ -1,7 +1,22 @@
# Making comments on the website
This section will explain how to use the extension in order to make comments.
This section will explain how to use the extension hypothesis in order to make comments.
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
Add this to `_config.yml`. Need to create an account.
```
html:
comments:
hypothesis: true
```
```{admonition} Tips
:class: tip
- use {ref}`remove_from_publish` to enable in Draft book only
```