From 569ecfe72a31342810e5e3f98cdf91297f7da1f8 Mon Sep 17 00:00:00 2001 From: Sacha Chua Date: Tue, 5 Dec 2023 16:08:50 -0500 Subject: link chapters --- 2023/info/doc-after.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) (limited to '2023/info/doc-after.md') diff --git a/2023/info/doc-after.md b/2023/info/doc-after.md index 9ac644ba..04e2dfc7 100644 --- a/2023/info/doc-after.md +++ b/2023/info/doc-after.md @@ -5,7 +5,7 @@ # Transcript -Introduction +[[!template text="""Introduction""" video="00:00:00.000" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Hello, everyone.""" start="00:00:00.000" video="mainVideo-doc" id="subtitle"]] [[!template text="""This talk is on literate documentation""" start="00:00:04.320" video="mainVideo-doc" id="subtitle"]] @@ -27,7 +27,7 @@ Introduction [[!template text="""It can be an outliner, a to-do list manager,""" start="00:00:51.160" video="mainVideo-doc" id="subtitle"]] [[!template text="""an agenda, organizer, and much more.""" start="00:00:54.240" video="mainVideo-doc" id="subtitle"]] -Org Babel and literate programming +[[!template text="""Org Babel and literate programming""" video="00:00:57.760" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Today, we're going to be demonstrating""" start="00:00:57.760" video="mainVideo-doc" id="subtitle"]] [[!template text="""what I consider to be org-mode's killer feature called""" start="00:00:59.600" video="mainVideo-doc" id="subtitle"]] @@ -57,7 +57,7 @@ Org Babel and literate programming [[!template text="""tangled out of the document and submitted to the machine""" start="00:02:04.800" video="mainVideo-doc" id="subtitle"]] [[!template text="""either to be compiled or interpreted and ultimately run.""" start="00:02:08.440" video="mainVideo-doc" id="subtitle"]] -This presentation +[[!template text="""This presentation""" video="00:02:14.080" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Throughout this presentation, you'll""" start="00:02:14.080" video="mainVideo-doc" id="subtitle"]] [[!template text="""see my browser window here on the left side of the screen.""" start="00:02:15.600" video="mainVideo-doc" id="subtitle"]] @@ -109,7 +109,7 @@ This presentation [[!template text="""it to export a RedHat-specific version of my building""" start="00:04:44.800" video="mainVideo-doc" id="subtitle"]] [[!template text="""Emacs from source essay or a Debian-specific version.""" start="00:04:48.720" video="mainVideo-doc" id="subtitle"]] -Getting started +[[!template text="""Getting started""" video="00:04:53.480" id="subtitle"mainVideo-doc]] [[!template new="1" text="""All right, let's get started.""" start="00:04:53.480" video="mainVideo-doc" id="subtitle"]] [[!template text="""We'll begin by firing up a new terminal Emacs session""" start="00:04:55.320" video="mainVideo-doc" id="subtitle"]] @@ -156,7 +156,7 @@ Getting started [[!template text="""you can see all the possible completions.""" start="00:06:50.360" video="mainVideo-doc" id="subtitle"]] [[!template text="""And as you can see, there's a lot.""" start="00:06:53.120" video="mainVideo-doc" id="subtitle"]] -README +[[!template text="""README""" video="00:06:55.780" id="subtitle"mainVideo-doc]] [[!template new="1" text="""The next thing we're gonna do is make a README section""" start="00:06:55.780" video="mainVideo-doc" id="subtitle"]] [[!template text="""at the top of this document.""" start="00:06:58.520" video="mainVideo-doc" id="subtitle"]] @@ -170,7 +170,7 @@ README [[!template text="""can potentially execute code""" start="00:07:17.760" video="mainVideo-doc" id="subtitle"]] [[!template text="""and just a little something about what the document is for.""" start="00:07:19.800" video="mainVideo-doc" id="subtitle"]] -Writing a code block +[[!template text="""Writing a code block""" video="00:07:23.500" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Okay, so now that we've written some text,""" start="00:07:23.500" video="mainVideo-doc" id="subtitle"]] [[!template text="""let's try our hand at writing a code block.""" start="00:07:26.060" video="mainVideo-doc" id="subtitle"]] @@ -192,7 +192,7 @@ Writing a code block [[!template text="""So that's great and all,""" start="00:08:06.980" video="mainVideo-doc" id="subtitle"]] [[!template text="""but there are a couple of things I don't like.""" start="00:08:08.080" video="mainVideo-doc" id="subtitle"]] -:results none +[[!template text=""":results none""" video="00:08:10.460" id="subtitle"mainVideo-doc]] [[!template new="1" text="""First of all, we don't need to see a #+RESULTS block here,""" start="00:08:10.460" video="mainVideo-doc" id="subtitle"]] [[!template text="""and that's because we're not really interested""" start="00:08:13.600" video="mainVideo-doc" id="subtitle"]] @@ -206,7 +206,7 @@ Writing a code block [[!template text="""So I'll always refer back to the org-mode manual""" start="00:08:35.360" video="mainVideo-doc" id="subtitle"]] [[!template text="""when working with them.""" start="00:08:38.920" video="mainVideo-doc" id="subtitle"]] -Confirmation +[[!template text="""Confirmation""" video="00:08:40.320" id="subtitle"mainVideo-doc]] [[!template new="1" text="""The second thing I don't like is that""" start="00:08:40.320" video="mainVideo-doc" id="subtitle"]] [[!template text="""when we hit C-c C-c to execute the block,""" start="00:08:42.160" video="mainVideo-doc" id="subtitle"]] @@ -246,7 +246,7 @@ Confirmation [[!template text="""you can see that Emacs' customize tooling""" start="00:10:29.560" video="mainVideo-doc" id="subtitle"]] [[!template text="""helpfully updated this variable in our config file for us.""" start="00:10:32.520" video="mainVideo-doc" id="subtitle"]] -Running blocks automatically +[[!template text="""Running blocks automatically""" video="00:10:36.960" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now that's great and all,""" start="00:10:36.960" video="mainVideo-doc" id="subtitle"]] [[!template text="""but I really don't like having to hit `C-c C-c`""" start="00:10:38.120" video="mainVideo-doc" id="subtitle"]] @@ -323,7 +323,7 @@ Running blocks automatically [[!template text="""and explain to the reader of the exported document""" start="00:13:47.880" video="mainVideo-doc" id="subtitle"]] [[!template text="""what this is all about.""" start="00:13:51.440" video="mainVideo-doc" id="subtitle"]] -Export options +[[!template text="""Export options""" video="00:13:53.000" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now as you can see, we've actually hard-coded""" start="00:13:53.000" video="mainVideo-doc" id="subtitle"]] [[!template text="""the name of the Linux distro in our prose.""" start="00:13:55.640" video="mainVideo-doc" id="subtitle"]] @@ -379,7 +379,7 @@ Export options [[!template text="""Now when we export the document again,""" start="00:16:00.980" video="mainVideo-doc" id="subtitle"]] [[!template text="""it should look a lot better.""" start="00:16:03.120" video="mainVideo-doc" id="subtitle"]] -Substituting constants +[[!template text="""Substituting constants""" video="00:16:05.700" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now that we've cleaned up the look of the exported document,""" start="00:16:05.700" video="mainVideo-doc" id="subtitle"]] [[!template text="""we'll take a look at a better way""" start="00:16:09.060" video="mainVideo-doc" id="subtitle"]] @@ -405,7 +405,7 @@ Substituting constants [[!template text="""And that's where we'll put the properties drawer""" start="00:17:14.000" video="mainVideo-doc" id="subtitle"]] [[!template text="""with the "distro" property.""" start="00:17:19.560" video="mainVideo-doc" id="subtitle"]] -Getting the properties +[[!template text="""Getting the properties""" video="00:17:25.740" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now the question is,""" start="00:17:25.740" video="mainVideo-doc" id="subtitle"]] [[!template text="""how do we reference these properties in the document?""" start="00:17:27.120" video="mainVideo-doc" id="subtitle"]] @@ -466,7 +466,7 @@ Getting the properties [[!template text="""it looks like what we'd expect.""" start="00:19:58.240" video="mainVideo-doc" id="subtitle"]] [[!template text="""Now this is getting better, but it's still not great.""" start="00:20:00.290" video="mainVideo-doc" id="subtitle"]] -Macros +[[!template text="""Macros""" video="00:20:03.060" id="subtitle"mainVideo-doc]] [[!template new="1" text="""The `call_` syntax is pretty cumbersome,""" start="00:20:03.060" video="mainVideo-doc" id="subtitle"]] [[!template text="""and it's a lot to type every time we want""" start="00:20:05.840" video="mainVideo-doc" id="subtitle"]] @@ -491,7 +491,7 @@ Macros [[!template text="""That's six curly braces in total we're typing,""" start="00:20:58.700" video="mainVideo-doc" id="subtitle"]] [[!template text="""which still takes up a fair amount of space.""" start="00:21:01.280" video="mainVideo-doc" id="subtitle"]] -Properties in practice +[[!template text="""Properties in practice""" video="00:21:05.240" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now let's take a look at how we might use""" start="00:21:05.240" video="mainVideo-doc" id="subtitle"]] [[!template text="""these properties in practice.""" start="00:21:07.120" video="mainVideo-doc" id="subtitle"]] @@ -516,7 +516,7 @@ Properties in practice [[!template text="""a bunch of different properties,""" start="00:22:05.200" video="mainVideo-doc" id="subtitle"]] [[!template text="""which is pretty janky.""" start="00:22:06.990" video="mainVideo-doc" id="subtitle"]] -Using a prefix +[[!template text="""Using a prefix""" video="00:22:09.020" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Luckily we can solve this problem""" start="00:22:09.020" video="mainVideo-doc" id="subtitle"]] [[!template text="""with a little bit of Emacs Lisp.""" start="00:22:11.080" video="mainVideo-doc" id="subtitle"]] @@ -551,7 +551,7 @@ Using a prefix [[!template text="""Let's see that in action.""" start="00:23:35.330" video="mainVideo-doc" id="subtitle"]] [[!template text="""All right, now we're talking.""" start="00:23:40.000" video="mainVideo-doc" id="subtitle"]] -Switching distributions +[[!template text="""Switching distributions""" video="00:23:42.010" id="subtitle"mainVideo-doc]] [[!template new="1" text="""This setup is starting to look pretty good,""" start="00:23:42.010" video="mainVideo-doc" id="subtitle"]] [[!template text="""but there are just a few things""" start="00:23:44.420" video="mainVideo-doc" id="subtitle"]] @@ -632,7 +632,7 @@ Switching distributions [[!template text="""which I hope is a point that folks take away from this talk.""" start="00:27:06.680" video="mainVideo-doc" id="subtitle"]] [[!template text="""All right, that was a lot.""" start="00:27:12.150" video="mainVideo-doc" id="subtitle"]] -A tour +[[!template text="""A tour""" video="00:27:14.150" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now that we've spent the past 20 minutes or so""" start="00:27:14.150" video="mainVideo-doc" id="subtitle"]] [[!template text="""digging into some of the tips and tricks I used""" start="00:27:16.840" video="mainVideo-doc" id="subtitle"]] @@ -704,7 +704,7 @@ A tour [[!template text="""and the section on executing""" start="00:30:12.330" video="mainVideo-doc" id="subtitle"]] [[!template text="""the document's various code blocks.""" start="00:30:14.080" video="mainVideo-doc" id="subtitle"]] -TeX and LaTeX +[[!template text="""TeX and LaTeX""" video="00:30:16.200" id="subtitle"mainVideo-doc]] [[!template new="1" text="""The latter two sections we'll take a look at now.""" start="00:30:16.200" video="mainVideo-doc" id="subtitle"]] [[!template text="""Out of the box on Fedora and Ubuntu server distros,""" start="00:30:19.200" video="mainVideo-doc" id="subtitle"]] @@ -725,7 +725,7 @@ TeX and LaTeX [[!template text="""that knows how to run LaTeX multiple times""" start="00:31:02.400" video="mainVideo-doc" id="subtitle"]] [[!template text="""in order to properly deal with intra-document links.""" start="00:31:05.140" video="mainVideo-doc" id="subtitle"]] -Other prerequisites +[[!template text="""Other prerequisites""" video="00:31:09.250" id="subtitle"mainVideo-doc]] [[!template new="1" text="""But wait, there's more.""" start="00:31:09.250" video="mainVideo-doc" id="subtitle"]] [[!template text="""We're also gonna need Inkscape""" start="00:31:11.070" video="mainVideo-doc" id="subtitle"]] @@ -748,7 +748,7 @@ Other prerequisites [[!template text="""to work on bog-standard Emacs setups,""" start="00:31:55.760" video="mainVideo-doc" id="subtitle"]] [[!template text="""I didn't get around to it.""" start="00:31:58.000" video="mainVideo-doc" id="subtitle"]] -Caching +[[!template text="""Caching""" video="00:32:00.060" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Before we get into talking about running the document,""" start="00:32:00.060" video="mainVideo-doc" id="subtitle"]] [[!template text="""let's talk briefly about results caching.""" start="00:32:03.140" video="mainVideo-doc" id="subtitle"]] @@ -838,7 +838,7 @@ Caching [[!template text="""Ooh, those are the words I love to see in the status area,""" start="00:36:14.040" video="mainVideo-doc" id="subtitle"]] [[!template text="""PDF file produced!""" start="00:36:17.560" video="mainVideo-doc" id="subtitle"]] -Looking at the PDF +[[!template text="""Looking at the PDF""" video="00:36:20.610" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Now I can't use my web browser""" start="00:36:20.610" video="mainVideo-doc" id="subtitle"]] [[!template text="""to take a look at this PDF file""" start="00:36:22.600" video="mainVideo-doc" id="subtitle"]] @@ -902,7 +902,7 @@ Looking at the PDF [[!template text="""And this is dynamically generated based on what we saw here.""" start="00:39:22.780" video="mainVideo-doc" id="subtitle"]] [[!template text="""So that's what we use here.""" start="00:39:27.480" video="mainVideo-doc" id="subtitle"]] -Errors +[[!template text="""Errors""" video="00:39:29.440" id="subtitle"mainVideo-doc]] [[!template new="1" text="""In this case, we're piping standard error""" start="00:39:29.440" video="mainVideo-doc" id="subtitle"]] [[!template text="""to where standard out goes.""" start="00:39:32.920" video="mainVideo-doc" id="subtitle"]] @@ -970,7 +970,7 @@ Errors [[!template text="""like the file sizes of everything in the home directory.""" start="00:42:23.980" video="mainVideo-doc" id="subtitle"]] [[!template text="""And then we, you know, show the binaries that got installed.""" start="00:42:27.720" video="mainVideo-doc" id="subtitle"]] -Final thoughts +[[!template text="""Final thoughts""" video="00:42:31.990" id="subtitle"mainVideo-doc]] [[!template new="1" text="""Anyway, so this is the final thoughts section.""" start="00:42:31.990" video="mainVideo-doc" id="subtitle"]] [[!template text="""And my final thoughts are, is I hope you enjoyed this talk""" start="00:42:35.600" video="mainVideo-doc" id="subtitle"]] -- cgit v1.2.3