Commit Graph

69 Commits

Author SHA1 Message Date
Cedric
7565b83dde Use US spelling for acknowledgments 2024-12-26 19:52:26 +00:00
Hendrik Kleinwaechter
8e604075ae Remove foreword (#324)
* Remove foreword

It's empty and does not provide any value unless we actually manage to
have a decent foreword. So this removes it for now.

* Remove foreword everywhere

---------

Co-authored-by: Ced <ced@sdf.org>
2024-01-09 21:30:45 +01:00
Hendrik Kleinwaechter
4510616f20 Mix-ins Chapter (#319)
* Mixins

This adds additional photos and ideas to the mixins chapter.

* Fix order
2023-12-23 18:11:41 +01:00
cedounet
4b4d80d231 Bread types (#301)
* Review bread types chapter

* Fine tune bread tables

* Collect all flat bread into one section

Makes more sense to have it all within a section.

* Correct typos in bread types chap.

gasses is less ambigous than gases even if correct.

* Remove uppercases

More consistent withe the rest of the text.

* Rewrite bread type intro

* Rewrite some of the flatbread section

there is a lot of repetition though..

---------

Co-authored-by: Cedric <ced@awase.ostal>
2023-12-10 17:54:22 +01:00
cedounet
1e8db3a3c3 Review baking (#275)
* Review backing chapter

* Improve baking process flowchart

* Use positioning Library in TikZ

* Improve Dutch Oven flowchart
2023-11-12 23:02:31 +01:00
Ced
87b5e486bf Move bibliography at the end of the book
Where it belongs!
2023-11-08 16:50:02 +00:00
cedounet
37bd36917d Fix glossary (#260)
* Correct spelling mistakes in glossary

* Rorder glossary

So it actually is in alphabetical order...

Samnly typos here adn there.

* Improve Glossary typography

* Fix make4ht enumitem

Basically we bypass the style for ebook and HTML.
2023-10-25 23:06:29 +02:00
Hendrik Kleinwaechter
187fc1d0fc Glossary (#258)
* Glossary

This adds a glossary with common terms to the book

* Apply ordering changes

* Add PR feedback

* Move to backmatter
2023-10-22 20:18:11 +02:00
Ced
56ba7ad21e Review bread storage chapter 2023-10-10 15:42:45 +01:00
Ced
eabde1aba0 Review non-wheat chapter
Usual typos and text improvements plus a little LaTeX magic for better
typography
2023-10-07 13:55:17 +01:00
cedounet
9fe88efca9 Review starter types (#238)
* Correct wording, category for starter conversion

- Now a flowchart (and a renamed label)
- More explicit wording as per
https://github.com/hendricius/the-sourdough-framework/issues/234

* Fix warnings from make check

The one I am 100% sure are mistakes

* Review starter type chapter

- Add some new sections
- fine tune tables
- some typos/new paragraphs

* Fix typos in sourdough starter types

* Simplify liquid conversion flowchart

* Simplify stiff conversion flowchart

* Fine tune liquid conversion flowchart

* Update some of the images

* Improve explanation of conversion

* Update explanation for stiff starter conversion

* Update fall note

---------

Co-authored-by: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>
2023-09-27 17:23:06 +02:00
cedounet
474051f095 Flour types (#241)
* Fine tune tables in flour types chapter

* Add list of flowcharts in ebook (#240)

* Add list of flowcharts in ebook

* Mark menu as selected on list of flowcharts

---------

Co-authored-by: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>

* Review flour types chapter

---------

Co-authored-by: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>
2023-09-27 16:12:56 +02:00
cedounet
74fca62bf2 Starter chap (#214)
* Fix TeXnicalities in starter chapter

* Break text into paragraphs

* Reword sourdough chapter

* Add a label for the chapter
2023-09-12 07:27:31 +02:00
cedounet
cec83c623f Add label for sourdough basics chapter (#218)
So it is coherent with the rest.

Also I can track which chapters I reviewed and which one I did not that
way :D.
2023-09-05 15:05:15 +02:00
cedounet
170763615f Change colors for links and hyperref (#206)
* Change colors for links and hyperref

This is less in your face than what we previously had.

Discussion in :
https://github.com/hendricius/the-sourdough-framework/discussions/201

There might be ways to make that better (not in your face and clickable
?)
https://tex.stackexchange.com/questions/555663/create-a-table-of-contents-with-links-in-all-text-and-different-colours-for-sect

* Remove colors for links in To*

As per @hendricius input
2023-09-04 10:24:23 +02:00
cedounet
5574cb230c Mixins chapter (#203)
* Move mix-ins to its own chapter

I don't think it belongs to wheat one which is already packed,
Schwarzbort for once is usually with seeds added.

Once we have more pics it will be even more cramped in the wheat
chapter.

* Fix TeXnicalilities in mix-ins chapter

looooong lines, no use of sinunitx, abbreviations, etc..

* Fix typo

* Update book/book.tex

---------

Co-authored-by: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>
2023-08-28 17:05:08 +02:00
cedounet
0bbea33152 History chapter review (#198)
* Add intro to history chapter

* Improve paragraph breakdown

Hopefully slightly less dense to read.
2023-08-27 11:00:59 +02:00
cedounet
3f5f752dbd Wrong flowchart (#195)
* Remove unbreakable spaces in supporters list

That is just too much to ask TeX

* Change environnement to Figure for chem equation

This is not a flowchart...
2023-08-25 15:51:04 +02:00
cedounet
c563477773 Restructure preface into logical paragraphs (#192)
Plus some very small changes in the text
2023-08-24 09:43:15 +02:00
cedounet
35916c15f7 Add a flowchart environnement and its listof (#188)
* Add a flowchart environnement and its listof

So we can more easily access those flowcharts from pdf and website,
rather than looking in the crowded list of figures.

* Update book/troubleshooting/misc.tex

* Temporarily remove list of flow charts from web version

* Update clean target to deal with listofcharts

* Silent KOMA warnings (#190)

No functional change, but less warnings will help to read the logs.
Good idea anyway to use the key/value scheme

Co-authored-by: Cedric <ced@awase.ostal>

* Fix front-page for one sided printing (#189)

As it is manually placed, is prone to break on evry change of the page
geometry...  This one looks good though in today's conditions.

Co-authored-by: Cedric <ced@awase.ostal>

* Enable micro-typographical improvements (#191)

Few people will notice but this actually brings loads of improvements to
line breaking, handing punctuations etc.

* Revert "Temporarily remove list of flow charts from web version"

This reverts commit 9611b250d2.

* Implement listofflowchart for tex4ht

as per michal suggestion:
https://github.com/michal-h21/tex4ebook/issues/114#issuecomment-1688543095

---------

Co-authored-by: Cedric <ced@awase.ostal>
Co-authored-by: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>
2023-08-24 09:30:38 +02:00
cedounet
de02adb4c7 Silent KOMA warnings (#190)
No functional change, but less warnings will help to read the logs.
Good idea anyway to use the key/value scheme

Co-authored-by: Cedric <ced@awase.ostal>
2023-08-21 14:59:05 +02:00
cedounet
fad30fa1db Remove 2-sided option for pdf (#187)
As per poll and discussion in:
https://github.com/hendricius/the-sourdough-framework/discussions/181

Co-authored-by: Cedric <ced@awase.ostal>
2023-08-19 16:34:28 +02:00
cedounet
38ac7c6b11 Add list of table and list of figures (#178)
* Add bibliography to the ToC

* Add a list of tables at the end of the document

It needed shorter description that would fit.

* Add list of figures

* Add table of figures

* Fix a typo in short figure description

* Increase numwidth in list of figures

Prevents over-run of figure number and text
2023-08-18 11:27:16 +02:00
cedounet
b7cb0adc3e New Front page (#172)
* Improve Title page

- Made it full page (almost)
- Added a second page with links to github, license info and hard-copy
  book

* Add an xbb target for the cover page

For some reasons using picture outside float environment confuses the
ebook/dvi building

---------

Co-authored-by: Cedric <ced@awase.ostal>
2023-08-15 18:46:44 +02:00
cedounet
261d1fb6de Remove first-line indentation (#170)
Make pragraph indentation as per Hendrik's liking.
2023-08-15 18:41:07 +02:00
cedounet
f1788ff780 Reorg troubleshooting (#150)
* Reorganize troubleshooting section

- Classified in subcategories hopefully more logically

* Reorganise troubleshooting section step 2

Now put crust debugging later. I am not sure this is fundamental, but
maybe just showing my lack of experience here...

* Improve table of contents

- Use short ToC entry when needed
- Remove extra space now that we do not have large numbers in
  section names anymore
2023-07-14 13:53:26 +02:00
cedounet
fa91b6f06f Komascript (#148)
* Add chemfig package

Somhow forgot it in chemical equation commit 8004497b

* Change links colors to codeblue

Closes https://github.com/hendricius/the-sourdough-framework/issues/142

* Use KOMA-Script and twosided printing

Because it looks better.  Also gets rid of headers/footers on empty
pages

* Fix tex4ebook and komascript clash

See https://github.com/michal-h21/tex4ebook/issues/110

* Factor out packages into a sty file

Separates style details out of the main file, now that we start having
more and more style-related settings.

* Remove parskip

Not needed with Koma-script

* Remove tocloft package

Not needed with koma-script

* Use tocbasics instead of floats

to please kpmascript internal algorithm

* Add a bit more breathing space in ToC

so they are not stuck together at 11.11 onwards...
2023-07-13 16:32:00 +02:00
cedounet
ee7db7b481 Fix links colors (#144)
* Add chemfig package

Somhow forgot it in chemical equation commit 8004497b

* Change links colors to codeblue

Closes https://github.com/hendricius/the-sourdough-framework/issues/142
2023-07-09 20:38:56 +02:00
Hendrik Kleinwaechter
036031fda8 Fix missing design 2023-07-07 12:14:17 +02:00
Hendrik Kleinwaechter
b5491096b0 Website improvements for book (#137) 2023-07-06 09:01:35 +02:00
cedounet
17b5ae5f52 Various clean up (#134)
* Fix reference and grammar

* Remove obsolete package

* Use colored links in pdf, black when printed

We can debate the colors to use of course, I left the defaults in.
There are accessibility concerns with colors...

* Add supporter.csv to the list of TeX source

So we rebuild everytime we add a new supporter.

* Inline the list of supporters

Those guys are awesome, but do they really need to be in a table one per
line over 3 pages?

* Explicit figure location

h rarelly works, so making it clear top is also an option.
2023-06-30 11:47:09 +02:00
cedounet
4637c29a37 Use Siunitx package for dealing with units (#129)
It is complicated :
[1] The International System of Units (si), https://www.bipm.org/en/
measurement-units/.
[2] International System of Units from nist, http://physics.nist.gov/cuu/Units/
index.html.

And one will never get it right (space or not, half-space?) nor
consistent so using that instead.

I am not sure how times and hours, when to write digits and when in
letter so I did not change much..

Did not touch the tables as ebooks on github actions seems to break when
you look at them funny.

Co-authored-by: Cedric <ced@awase.ostal>
2023-06-28 20:30:12 +02:00
cedounet
05c33a76b6 Use input figs (#123)
* Make figs includable in main document

Remove the capability to build them as standalone document but we can
include them in the main document.  It should simplify things down the
road.

* Replace tikx pics

* Remove figures compilation from makefile

No need to compile figs to pdf anymore, at least to build the books

* Delete svg figures from ebook build

* Create png for TikZ figures

    - Add export_figures back
    - Build a pdf from the the TikZ in standalone mode
    - Change the cleanup to deal with those changes
    - Remove trailing spaces..

* Replace centering by an environment

More LaTeX idomatic

* Increase clean_figures robustness

as we use temporary tex files (.tex.in) we can't run clean_figures twice in a
row

* Center TikZ figures

Because it looks better

* Remove png building

Seems to struggle on CI with \\\b or something, we don't absolutely need
it right now so let's get rid of it.

* Remove trgt_figures dependency for pdf and ebooks

This should not be needed now that we include the TikZ directly, only
needed for png generation.

* Revert "Remove png building"

This reverts commit fdd542de57.

This is now fine to add the code back, so that it can be debugged when
times come.
2023-06-27 11:07:19 +02:00
cedounet
ca43ef0bd9 Improve typography (#120)
* Add unbreakable space before a reference or a citation

avoids ref to be put on next line or page...

* Add unbreakable space between I and verb

* Remove spacing before footnotes

Also moved it before the final sentence dots in many cases... might need
a review of what is best.  But this is a safe default choice from an
esthetic point of view.

* Improve footnotes and punctuations

Reverse order/kerning especially with sans-serif version.

* Remove manual enumerate

* Fix wording in a citation.

Reads better that way and is shorter.

* Use emph instead of italics

1) Markup semantic not style
2) Will deal with various level of empahasis
3) Was a mix of \it and \textit

* Fix usage of quotes

Also replaced some of then by \emph as it is (IMHO) more visually
pleasant.

* Captitalize before reference

* Correct dashes length

see here:
https://www.merriam-webster.com/words-at-play/em-dash-en-dash-how-to-use

* Remove space before label and homogenize caption

Apparently it can create a wrong reference, if notthing else shuts
texcheck up and cost nothing... so let's do it.

While at it adding a dot at the end of each caption.

* Add missing empty line before signature in preface

* Add a static checker target to makefile

Shall help prevent adding mistakes in new versions
2023-06-12 09:12:22 +02:00
cedounet
e451a47d55 improve makefiles (#113)
* Make headrow in tables bold

* Simplify tables markup

- Markup is definitely simpler.
- Will not be built separately in a pdf anymore.
- Fixed some typo as well
- Relatively coherent look
- Can be better, some sizes are relatively arbitrary

* Remove horizontal separation inside tables

Not very nice if you ask me..

* Fix some tables for the ebook

The alignement trick to have nicely alignment on = sign or on unit (g)
used broke the html. Reverting to a less optimal version on pdf while
not breaking the html.

* Simplify table for html output

* Revert "Simplify table for html output"

This reverts commit f85d65adb7.

* Revert pancake table

This way it builds ebook correctly.

* Use latexmk and dedicated build_directory

- Generic rule for building pdf from tex
- build the book in its own directory
- do not clean before

* Make accessible pdf a command line option

* Simplify accessible version generation

using the option in book.tex instead of copying files around.
TODO: figures/Tkiz still are with serif.

* Specify some dependencies as order only

We don't want to trigger a rebuild everytime the directory timestamp
changes

* Remove force rebuild

* Fix dependencies handling

- Explicit some dependencies
- Ebook must be handled manually as we don't have latexmk working with
  latexmk or not sure how to do it...

* Improve clean

- Use latexmk to clean where possible
- clean the sans-serif as well
- failing rm will output a non-stopping error now

* Cleanup and comment makefile

For clarity, also move things around

* Add an mrproper target

clean now only removes intermediate files, keeps pdf and ebook in there.
Mr proper will remove evrything

* Add dependency of figures for ebook

* Add default rules you expect

make will build the pdf
make all will build all

* Add a make help command

Gives list of useful targets and their action

* Use latexmk to build TikZ pictures

* Use latexmk for building ebooks

* Let latexmk handle dependencies

would get it wrong otherwise...

* Add rule for sans serif ebook

* Add dependencies on TikZ figures for ebooks

* add mk4 file for the sans_serif version of ebook

symlink to the other one as they should be the same.

* Reorder the makefile variables declaration

Looks like I did not fully understood how it works..

Also added some PHONY targets and comments

* Add missing actions in clean target

Some file got forgotten... clean the makefile as well.

* Split the clean in a clean ebook section

* Clean the ebook before building the pdf

Not idel but I have no idea how to have the intermediate files in
another directory with tex4ebook
2023-06-06 17:45:57 +02:00
cedounet
50bf7f1de4 Nicer tables episode II (#111)
* Make headrow in tables bold

* Simplify tables markup

- Markup is definitely simpler.
- Will not be built separately in a pdf anymore.
- Fixed some typo as well
- Relatively coherent look
- Can be better, some sizes are relatively arbitrary

* Remove horizontal separation inside tables

Not very nice if you ask me..

* Fix some tables for the ebook

The alignement trick to have nicely alignment on = sign or on unit (g)
used broke the html. Reverting to a less optimal version on pdf while
not breaking the html.

* Simplify table for html output

* Revert "Simplify table for html output"

This reverts commit f85d65adb7.

* Revert pancake table

This way it builds ebook correctly.
2023-06-03 00:02:39 +02:00
Hendrik Kleinwaechter
0d1602cc17 Revert "Nicer/Simpler tables (#107)"
This reverts commit 037ae6d7fd.
2023-06-01 18:49:38 +02:00
Hendrik Kleinwaechter
916b610a53 Fix images not displaying (#108) 2023-06-01 16:02:09 +02:00
cedounet
037ae6d7fd Nicer/Simpler tables (#107)
* Make headrow in tables bold

* Simplify tables markup

- Markup is definitely simpler.
- Will not be built separately in a pdf anymore.
- Fixed some typo as well
- Relatively coherent look
- Can be better, some sizes are relatively arbitrary

* Remove horizontal separation inside tables

Not very nice if you ask me..
2023-06-01 14:38:37 +02:00
Hendrik Kleinwaechter
c2d5e88377 Accessibility Sans Serif Option (#90)
* Accessibility Sans Serif Option

This adds another build processs where the book is built using a sans
serif font. This can facilitate reading the book for some users.

* Update readme
2023-05-21 12:19:59 +02:00
Hendrik Kleinwaechter
aa40844691 Fix chemical formula display (#65)
This uses the chemformula package to improve the display of chemical
formulas.
2023-03-30 09:15:32 +02:00
Hendrik Kleinwaechter
6e97f9bbd0 Screen Readers (#53)
* add tikzcache

* ignore files

* add latexmkrc file

* Move figures to new files

* rename images

* Fix build commands

* Release as epub3 and mobi

* Add cover-image support

* use older epub

* Externalize all tables

* change gh actions command

* fix linux xargs rm
2023-03-02 20:33:25 +01:00
Hendrik Kleinwaechter
36da690cb5 Storing Bread Chapter (#44)
This adds the chapter that looks at different bread
storing options.
2023-02-03 14:33:56 +01:00
Hendrik Kleinwaechter
8931b2775f Non wheat sourdough chapter (#43)
This adds the non-wheat sourdough chapter
2023-01-28 06:44:49 +01:00
Hendrik Kleinwaechter
4b3d8c4cc2 Shaping chapter (#41)
This includes all the information needed to properly shape your dough.
2023-01-20 14:02:10 +01:00
Hendrik Kleinwaechter
d915a721ec Dough ball steps (#31)
Adds instructions on how to make a smooth dough ball
2022-12-30 15:21:00 +01:00
Hendrik Kleinwaechter
69933ecda9 Document index page, reduce size of footnotes 2022-12-30 13:36:14 +01:00
Hendrik Kleinwaechter
6039f03712 Add note that chapter is pending 2022-12-18 14:25:20 +01:00
Hendrik Kleinwaechter
f85550bd92 Fix small mistaske (#27)
Also updates the chart style to match the bread code colors
2022-12-16 18:32:28 +01:00
Robert Schadek
d3a8668b11 Sourdough start tikz flowchart (#23)
Recreating the sourdough flowchart in tikz.
2022-12-16 14:25:03 +01:00