Skip to content

Commit

Permalink
v1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
fredguth committed Oct 27, 2022
1 parent cdd88d9 commit 601288a
Show file tree
Hide file tree
Showing 5 changed files with 587 additions and 7 deletions.
6 changes: 3 additions & 3 deletions 02-Main/customizing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can customize your book by changing `_quarto.yml` and the files it referende
- 02-Main: for mainmatter content;
- 03-Back: for backmatter content;

### Book Structure
## Book Structure

- Cover
- Front Matter
Expand All @@ -25,7 +25,7 @@ You can customize your book by changing `_quarto.yml` and the files it referende
- acknowledgements
- colophon

### File Structure
## File Structure

| Book Part | File | How to customize |
|-----------|:-------------------------|:-------------------|
Expand All @@ -45,6 +45,6 @@ In `_extensions/tufte/_extension.yml` you can check the default settings of the

The project uses [tufte-book](https://tufte-latex.github.io/tufte-latex/) Latex class.

### Customizing the Website
## Customizing the Website

Besides the settings from `_extensions/tufte/_extension.yml > format > html` that can be overwritten in `_quarto.yml > format > html`, you can further customize the website by creating a `style.css` file and referencing it in `_quarto.yml`. Check `_extensions/tufte/style.css` as an example, but avoid changing directly there as Tufte-Quarto updates may break your changes.
52 changes: 52 additions & 0 deletions 02-Main/known_issues.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Known-issues

1. Tufte-book can't handle label inside caption.

Tufte-book.cls breaks when processing the line bellow:

```qmd
![A way of flying](/Images/goya.jpg){.column-body #fig-goya}
```
which becomes:

```tex
\begin{figure}

{\centering \includegraphics{Images/goya.jpg}

}

\caption{\label{fig-goya}A way of flying}

\end{figure}
```

2. Can't render svg image in pdf and can't render pdf image in html.
- current solution is quite ugly:

```qmd
::: {.content-hidden unless-format="pdf" }

![IBT "genealogy" tree.](/Images/dissertation-map.pdf){.column-margin width=90%}

:::

::: {.content-hidden unless-format="html"}

![IBT "genealogy" tree.](/Images/dissertation-map.svg){.column-margin width=90%}

:::

```
For avoiding duplicating code, files are .svg in html by defaul and .pdf in pdf.
So you can only:

```qmd

![IBT "genealogy" tree.](/Images/dissertation-map){.column-margin width=90%}

```

3. Tufte-class works only until subsection -> `### subsection`; `#### subsubsection`-> returns error

4. sidecite is duplicating citations in the same margin. Solved this same problem in my dissertation and in the kaobook class. Only problem is that Tufte-book class is a little too cryptic for me.
514 changes: 514 additions & 0 deletions Images/bookcover.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ book:
chapters:
- index.qmd
- 02-Main/customizing.qmd
# - 02-Back/known_issues.qmd
- 02-Main/known_issues.qmd
- part: about.qmd
chapters:
- 03-Back/references.qmd
Expand Down
20 changes: 17 additions & 3 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,30 @@
:::
The Tufte-Quarto project is an homage to [Edward Tufte](#sec-tufte). It simplifies the production of books using a layout that resembles [his books](https://www.edwardtufte.com/tufte/books_vdqi)[@Tufte:vdqi; @Tufte:en; @Tufte:ve] with a companion website. The goal is for the book and website share the same aesthetics.

As an example, [my dissertation](https://fredguth.github.io/IBToDL) is being refactored with Tufte-Quarto, it gives an idea of the final result.
## Showcase

### Usage
### This documentation

This documention itself is using Tufte-Quarto.


::: {.content-visible when-format="html"}

[![Tufte-Quarto Documentation](/Images/bookcover){.column-margin #fig-cover}](./TufteStyledBook.pdf)

:::

### Dissertation
As an example, [my dissertation](https://fredguth.github.io/IBToDL) is being refactored with Tufte-Quarto, it gives an idea of a complex document built with Tufte-Quarto.

## Usage
To use this project type just:

`quarto use template fredguth/tufte-quarto`

::: {#sec-tufte}

### About Edward R. Tufte
## About Edward R. Tufte
Professor Emeritus of Political Science, Statistics and Computer Sciente at Yale University, Edward Tufte is an expert in the presentation of informational. Also known as *the godfather of charts*. Check [his website](https://www.edwardtufte.com/tufte/).

:::

0 comments on commit 601288a

Please sign in to comment.