Skip to content

Commit

Permalink
More renaming and moving content
Browse files Browse the repository at this point in the history
  • Loading branch information
jennybc committed Jan 8, 2019
1 parent c6cfe1b commit 4f56043
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 38 deletions.
6 changes: 3 additions & 3 deletions _bookdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ rmd_files: [
"prompt-search-github.Rmd",

"notes-intro.Rmd",
"classroom-overview.Rmd",
"ideas.Rmd",
"bookdown-cheat-sheet.Rmd",
"notes-classroom-overview.Rmd",
"notes-ideas.Rmd",
"notes-bookdown-cheat-sheet.Rmd",

"80_shell.Rmd",

Expand Down
28 changes: 28 additions & 0 deletions bookdown-cheat-sheet.Rmd → notes-bookdown-cheat-sheet.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,31 @@ knitr::kable(
```

You can write citations, too. For example, we are using the **bookdown** package [@R-bookdown] in this sample book, which was built on top of R Markdown and **knitr** [@xie2015].

## How the square bracket links work

Context: you prefer to link with text, not a chapter or section number.

* GOOD! Here's a link to [Contributors].
* BAD. You can see contributors in \@ref(contrib).

Facts and vocabulary

* Each chapter is a file. These files should begin with the chapter title using a level-one header, e.g., `# Chapter Title`.
* A chapter can be made up of sections, indicated by lower-level headers, e.g., `## A section within the chapter`.
* There are three ways to address a section when creating links within your book:
- **Explicit identifier**: In `# My header {#foo}` the explicit identifier is `foo`.
- **Automatically generated identifier**: `my-header` is the auto-identifier for `# My header`. Pandoc creates auto-identifiers according to rules laid out in [Extension: auto_identifiers](http://pandoc.org/README.html#extension-auto_identifiers).
- The header text, e.g., `My header` be used verbatim as an **implicit header reference**. See [Extension: implicit_header_references](http://pandoc.org/README.html#extension-implicit_header_references) for more.
* All 3 forms can be used to create cross-references but you build the links differently.
* Advantage of explicit identification: You are less likely to update the section header and then forget to make matching edits to references elsewhere in the book.

How to make text-based links using explicit identifiers, automatic identifiers, and implicit references:

* Use implicit reference alone to get a link where the text is exactly the section header:
- `[Introduce yourself to Git]` [Introduce yourself to Git]
- `[Success and operating systems]` [Success and operating systems]
* You can provide custom text for the link with all 3 methods of addressing a section:
- Implicit header reference: `[link text][Recommended Git clients]` [link text][Recommended Git clients]
- Explicit identifier: `[hello git! I'm Jenny](#hello-git)` [hello git! I'm Jenny](#hello-git)
- Automatic identifier: `[Any text you want](#recommended-git-clients)` [Any text you want](#recommended-git-clients)
4 changes: 2 additions & 2 deletions classroom-overview.Rmd → notes-classroom-overview.Rmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# (PART) Classroom {-}

# Run a course with GitHub {#classroom-overview}

*This content is rather stale and unlikely to see further development.*

GitHub makes a wonderful platform on which to run a course. I've been doing this on [github.com](https://github.com) since 2014 in [STAT 545](http://stat545.com), an 80-student grad course in data analysis with R, and in a second large, code-intensive graduate course in statistical genomics. We're running all of the courses for UBC's [Master of Data Science program](https://ubc-mds.github.io) off a private instance of [GitHub Enterprise](https://enterprise.github.com/home) hosted in Canada.

## Benefits
Expand Down
34 changes: 1 addition & 33 deletions ideas.Rmd → notes-ideas.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# (PART) Meta {-}

# Notes

Notes for future
Ideas for content

## Common workflow questions

Expand Down Expand Up @@ -123,31 +119,3 @@ Workflows for group of 1, 2, 5, 10

- <https://help.github.com/articles/about-collaborative-development-models/>
- <https://help.github.com/articles/using-pull-requests/>

## How the square bracket links work

Context: you prefer to link with text, not a chapter or section number.

* GOOD! Here's a link to [Contributors].
* BAD. You can see contributors in \@ref(contrib).

Facts and vocabulary

* Each chapter is a file. These files should begin with the chapter title using a level-one header, e.g., `# Chapter Title`.
* A chapter can be made up of sections, indicated by lower-level headers, e.g., `## A section within the chapter`.
* There are three ways to address a section when creating links within your book:
- **Explicit identifier**: In `# My header {#foo}` the explicit identifier is `foo`.
- **Automatically generated identifier**: `my-header` is the auto-identifier for `# My header`. Pandoc creates auto-identifiers according to rules laid out in [Extension: auto_identifiers](http://pandoc.org/README.html#extension-auto_identifiers).
- The header text, e.g., `My header` be used verbatim as an **implicit header reference**. See [Extension: implicit_header_references](http://pandoc.org/README.html#extension-implicit_header_references) for more.
* All 3 forms can be used to create cross-references but you build the links differently.
* Advantage of explicit identification: You are less likely to update the section header and then forget to make matching edits to references elsewhere in the book.

How to make text-based links using explicit identifiers, automatic identifiers, and implicit references:

* Use implicit reference alone to get a link where the text is exactly the section header:
- `[Introduce yourself to Git]` [Introduce yourself to Git]
- `[Success and operating systems]` [Success and operating systems]
* You can provide custom text for the link with all 3 methods of addressing a section:
- Implicit header reference: `[link text][Recommended Git clients]` [link text][Recommended Git clients]
- Explicit identifier: `[hello git! I'm Jenny](#hello-git)` [hello git! I'm Jenny](#hello-git)
- Automatic identifier: `[Any text you want](#recommended-git-clients)` [Any text you want](#recommended-git-clients)

0 comments on commit 4f56043

Please sign in to comment.