Skip to content

Commit

Permalink
Footnotes in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kgjerde committed Jun 20, 2019
1 parent 10cac3d commit 3fbd7ab
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 19 deletions.
8 changes: 5 additions & 3 deletions README.Rmd
Expand Up @@ -44,6 +44,10 @@ install.packages("devtools")
devtools::install_github("kgjerde/corporaexplorer")
```

**corporaexplorer** works on Mac OS, Windows and Linux.
(The Shiny apps' user interface is rather clunkier on Windows than on the other platforms,
but the apps are fully functional.)

*Note to developers:
The package's internal test suite uses the [`shinytest`](https://github.com/rstudio/shinytest) package,
which requires that [`PhantomJS`](http://phantomjs.org/) is installed.
Expand Down Expand Up @@ -108,7 +112,7 @@ For a BibTeX entry, use the output from `citation(package = "corporaexplorer")`.

## A note on platforms and encoding

**corporaexplorer** works on Mac OS, Windows and Linux,<sup>[3](#footnote3)</sup>
**corporaexplorer** works on Mac OS, Windows and Linux,
and there are some important differences in how R handles text
on the different platforms.
If you are working with plain English text,
Expand Down Expand Up @@ -149,5 +153,3 @@ Contributions in the form of feedback, bug reports and code are most welcome. Wa
<hr>

<a name="footnote1">*1</a>. All this material is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).*
<a name="footnote2">*2</a>. Using the [`jquery.scrollTo`](https://github.com/flesler/jquery.scrollTo) plugin.*
<a name="footnote3">*3</a>. That said, the package is developed on Mac OS, and the Shiny apps' user interface is rather clunkier on Windows.*
26 changes: 12 additions & 14 deletions README.md
Expand Up @@ -48,6 +48,10 @@ install.packages("devtools")
devtools::install_github("kgjerde/corporaexplorer")
```

**corporaexplorer** works on Mac OS, Windows and Linux. (The Shiny apps’
user interface is rather clunkier on Windows than on the other
platforms, but the apps are fully functional.)

*Note to developers: The package’s internal test suite uses the
[`shinytest`](https://github.com/rstudio/shinytest) package, which
requires that [`PhantomJS`](http://phantomjs.org/) is installed. This
Expand Down Expand Up @@ -132,14 +136,13 @@ For a BibTeX entry, use the output from `citation(package =

## A note on platforms and encoding

**corporaexplorer** works on Mac OS, Windows and
Linux,<sup>[3](#footnote3)</sup> and there are some important
differences in how R handles text on the different platforms. If you are
working with plain English text, there will most likely be no issues
with encoding on any platform. Unfortunately, working with
non-[ASCII](https://en.wikipedia.org/wiki/ASCII) encoded text in R
(e.g. non-English characters), *can* be complicated – in particular on
Windows.
**corporaexplorer** works on Mac OS, Windows and Linux, and there are
some important differences in how R handles text on the different
platforms. If you are working with plain English text, there will most
likely be no issues with encoding on any platform. Unfortunately,
working with non-[ASCII](https://en.wikipedia.org/wiki/ASCII) encoded
text in R (e.g. non-English characters), *can* be complicated – in
particular on Windows.

**On Mac OS or Linux**, problems with encoding will likely not arise at
all. If problems do arise, they can typically be solved by making the R
Expand Down Expand Up @@ -175,9 +178,4 @@ welcome. Ways to contribute:
<hr>

<a name="footnote1">*1</a>. All this material is licensed under Creative
Commons Attribution 4.0 International (CC BY 4.0).*
<a name="footnote2">*2</a>. Using the
[`jquery.scrollTo`](https://github.com/flesler/jquery.scrollTo)
plugin.*
<a name="footnote3">*3</a>. That said, the package is developed on Mac
OS, and the Shiny apps’ user interface is rather clunkier on Windows.*
Commons Attribution 4.0 International (CC BY 4.0).*
7 changes: 6 additions & 1 deletion usage.Rmd
Expand Up @@ -172,7 +172,7 @@ knitr::include_graphics("man/figures/day_corpus.png")

<br>

Clicking on a "document tile" produces two things. First, the full text of the document with search terms highlighted. Second, above the text a tile chart consisting of n tiles where each tile represents a 1/n part of the document, and where the colour in a tile indicates whether and how many times the search term is found in that part of the document. Clicking on a tile scrolls the document to the corresponding part of the document.<sup>[2](#footnote2)</sup>
Clicking on a "document tile" produces two things. First, the full text of the document with search terms highlighted. Second, above the text a tile chart consisting of n tiles where each tile represents a 1/n part of the document, and where the colour in a tile indicates whether and how many times the search term is found in that part of the document. Clicking on a tile scrolls the document to the corresponding part of the document.<sup>[1](#footnote1)</sup>

```{r out.width="80%", echo=FALSE}
knitr::include_graphics("man/figures/wall.png")
Expand Down Expand Up @@ -239,3 +239,8 @@ of 400 documents to be included in one report (can be changed in the

Speed is considered to be of less importance in this app, and all searches
are carried out as full text searches with `stringr`. Again, note that a single backslash is used as escape character. For example will `\.` match a literal ".", and `\d` match any digit.

<hr>


<a name="footnote1">*1</a>. Using the [`jquery.scrollTo`](https://github.com/flesler/jquery.scrollTo) plugin.*
7 changes: 6 additions & 1 deletion usage.md
Expand Up @@ -226,7 +226,7 @@ tile chart consisting of n tiles where each tile represents a 1/n part
of the document, and where the colour in a tile indicates whether and
how many times the search term is found in that part of the document.
Clicking on a tile scrolls the document to the corresponding part of the
document.<sup>[2](#footnote2)</sup>
document.<sup>[1](#footnote1)</sup>

<img src="man/figures/wall.png" width="80%" />

Expand Down Expand Up @@ -308,3 +308,8 @@ Speed is considered to be of less importance in this app, and all
searches are carried out as full text searches with `stringr`. Again,
note that a single backslash is used as escape character. For example
will `\.` match a literal “.”, and `\d` match any digit.

<hr>

<a name="footnote1">*1</a>. Using the
[`jquery.scrollTo`](https://github.com/flesler/jquery.scrollTo) plugin.*

0 comments on commit 3fbd7ab

Please sign in to comment.