From 8aa5327fc7d5e995d2821840136a268632bb4110 Mon Sep 17 00:00:00 2001 From: jethrokuan Date: Sun, 31 May 2020 06:23:57 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20b2594?= =?UTF-8?q?b84aef131ab24dd477a4bd7b2d1a6ca7621=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...troduction-to-the-Zettelkasten-Method.html | 110 ++++++++++++++++++ manual/Anatomy-of-an-Org_002droam-File.html | 2 +- manual/Appendix.html | 2 +- manual/Concepts-and-Configuration.html | 2 +- manual/Deft.html | 2 +- manual/Diagnosing-and-Repairing-Files.html | 2 +- manual/Directories-and-Files.html | 2 +- manual/Ecosystem.html | 2 +- manual/Encryption.html | 2 +- manual/Excluding-Nodes-and-Edges.html | 2 +- manual/FAQ.html | 2 +- manual/File-Refs.html | 2 +- manual/Getting-Started.html | 2 +- manual/Graph-Options.html | 2 +- manual/Graphing.html | 2 +- ...-than-one-Org_002droam-directory_003f.html | 2 +- manual/Index-File.html | 2 +- manual/Installation-_00281_0029.html | 2 +- manual/Installation.html | 6 +- manual/Installing-from-MELPA.html | 14 ++- .../Installing-from-the-Git-Repository.html | 2 +- manual/Introduction.html | 6 +- manual/Navigating-Around.html | 2 +- manual/Note_002dtaking-Add_002dons.html | 2 +- manual/Note_002dtaking-Workflows.html | 2 +- manual/Org_002djournal.html | 2 +- manual/Org_002droam-Completion-System.html | 2 +- manual/Org_002droam-Files.html | 2 +- manual/Org_002droam-Links.html | 2 +- manual/Org_002droam-Template-Expansion.html | 2 +- manual/Post_002dInstallation-Tasks.html | 2 +- manual/Roam-Protocol.html | 2 +- manual/Tags.html | 2 +- manual/Template-Walkthrough.html | 2 +- manual/The-Org_002droam-Buffer.html | 2 +- manual/The-Templating-System.html | 2 +- manual/The-roam_002dfile-protocol.html | 2 +- manual/The-roam_002dref-Protocol.html | 2 +- manual/Titles.html | 2 +- manual/_005f.html | 2 +- manual/index.html | 95 +++++++-------- org-roam.org | 63 ++++++++-- org-roam.texi | 45 ++++++- 43 files changed, 308 insertions(+), 103 deletions(-) create mode 100644 manual/A-Brief-Introduction-to-the-Zettelkasten-Method.html diff --git a/manual/A-Brief-Introduction-to-the-Zettelkasten-Method.html b/manual/A-Brief-Introduction-to-the-Zettelkasten-Method.html new file mode 100644 index 0000000..b44012f --- /dev/null +++ b/manual/A-Brief-Introduction-to-the-Zettelkasten-Method.html @@ -0,0 +1,110 @@ + + + + + + +A Brief Introduction to the Zettelkasten Method (Org-roam User Manual) + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents]

+
+
+ +

2 A Brief Introduction to the Zettelkasten Method

+ +

Org-roam provides utilities for maintaining a digital slip-box. This section +aims to provide a brief introduction to the “slip-box”, or “Zettelkasten” +method. By providing some background on the method, we hope that the design +decisions of Org-roam will become clear, and that will aid in using Org-roam +appropriately. In this section we will also introduce terms commonly used within +the Zettelkasten community, which will also commonly appear in the Org-roam +forums and channels of discussion. +

+

The Zettelkasten method of note-taking is designed to increase research +productivity: in particular, it acts as a research partner, where conversations +with it may produce new and surprising lines of thought. This method is +attributed to German sociologist Niklas Luhmann, who using the method had +produced volumes of written works. +

+

In its paper form, the slip-box is simply a box of cards. These cards are small, +and often only large enough to fit a single concept. The size limitation +encourages ideas to be broken down into individual concepts. These ideas are +explicitly linked together, using an indexing system. Enforcing the breakdown of +ideas encourages tangential exploration of ideas, increasing the surface for +thought. Making linking explicit between notes also encourages one to think +about the connections between concepts, which forms a large part of research. +

+

Org-roam is the slip-box, digitalized in Org-mode. Every zettel (card) is a +plain-text, Org-mode file. These files are often placed in the same directory. +In the same way one would maintain a paper slip-box, Org-roam makes it easy to +create new zettels, pre-filling boilerplate content using a powerful templating +system. Org-roam also facilitates the linking of zettels using Org-mode file: +links. +

+
+
+

+Next: , Previous: , Up: Top   [Contents]

+
+ + + + + diff --git a/manual/Anatomy-of-an-Org_002droam-File.html b/manual/Anatomy-of-an-Org_002droam-File.html index d702e93..62ac9d2 100644 --- a/manual/Anatomy-of-an-Org_002droam-File.html +++ b/manual/Anatomy-of-an-Org_002droam-File.html @@ -67,7 +67,7 @@ Next:
-

4 Anatomy of an Org-roam File

+

5 Anatomy of an Org-roam File

The bulk of Org-roam’s functionality is built on top of vanilla Org-mode. However, to support additional functionality, Org-roam adds diff --git a/manual/Appendix.html b/manual/Appendix.html index 8816a9c..a53b065 100644 --- a/manual/Appendix.html +++ b/manual/Appendix.html @@ -67,7 +67,7 @@ Next: , Previous:

-

13 Appendix

+

14 Appendix

• Note-taking Workflows:   diff --git a/manual/Concepts-and-Configuration.html b/manual/Concepts-and-Configuration.html index b1b4b11..39f5c48 100644 --- a/manual/Concepts-and-Configuration.html +++ b/manual/Concepts-and-Configuration.html @@ -67,7 +67,7 @@ Next: -

6 Concepts and Configuration

+

7 Concepts and Configuration

The number of configuration options is deliberately kept small, to keep the Org-roam codebase manageable. However, we attempt to accommodate as diff --git a/manual/Deft.html b/manual/Deft.html index 1a5351a..ac90888 100644 --- a/manual/Deft.html +++ b/manual/Deft.html @@ -67,7 +67,7 @@ Next:

-

13.2.1 Deft

+

14.2.1 Deft

Deft provides a nice interface for browsing and filtering org-roam notes. diff --git a/manual/Diagnosing-and-Repairing-Files.html b/manual/Diagnosing-and-Repairing-Files.html index 9eda01b..4f9e2c3 100644 --- a/manual/Diagnosing-and-Repairing-Files.html +++ b/manual/Diagnosing-and-Repairing-Files.html @@ -67,7 +67,7 @@ Next: , Pr

-

12 Diagnosing and Repairing Files

+

13 Diagnosing and Repairing Files

Org-roam provides a utility for diagnosing and repairing problematic files via ‘org-roam-doctor’. By default, ‘org-roam-doctor’ runs the check across all Org-roam diff --git a/manual/Directories-and-Files.html b/manual/Directories-and-Files.html index db8654c..0b20a03 100644 --- a/manual/Directories-and-Files.html +++ b/manual/Directories-and-Files.html @@ -67,7 +67,7 @@ Next: -

6.1 Directories and Files

+

7.1 Directories and Files

This section concerns the placement and creation of files.

diff --git a/manual/Ecosystem.html b/manual/Ecosystem.html index 7cafa4b..4097143 100644 --- a/manual/Ecosystem.html +++ b/manual/Ecosystem.html @@ -67,7 +67,7 @@ Previous:
-

13.2 Ecosystem

+

14.2 Ecosystem

A number of packages work well combined with Org-Roam:

diff --git a/manual/Encryption.html b/manual/Encryption.html index 745fafb..c54a7d3 100644 --- a/manual/Encryption.html +++ b/manual/Encryption.html @@ -67,7 +67,7 @@ Next: , Pr
-

8 Encryption

+

9 Encryption

One may wish to keep private, encrypted files. Org-roam supports encryption (via GPG), which can be enabled for all new files by setting ‘org-roam-encrypt-files’ diff --git a/manual/Excluding-Nodes-and-Edges.html b/manual/Excluding-Nodes-and-Edges.html index 51bd470..aba865e 100644 --- a/manual/Excluding-Nodes-and-Edges.html +++ b/manual/Excluding-Nodes-and-Edges.html @@ -67,7 +67,7 @@ Previous:

-

9.2 Excluding Nodes and Edges

+

10.2 Excluding Nodes and Edges

One may want to exclude certain files to declutter the graph.

diff --git a/manual/FAQ.html b/manual/FAQ.html index fae68c2..3d51c00 100644 --- a/manual/FAQ.html +++ b/manual/FAQ.html @@ -67,7 +67,7 @@ Previous:
-

14 FAQ

+

15 FAQ

• How do I have more than one Org-roam directory?:   diff --git a/manual/File-Refs.html b/manual/File-Refs.html index 8b0885f..cbcd3e1 100644 --- a/manual/File-Refs.html +++ b/manual/File-Refs.html @@ -67,7 +67,7 @@ Previous: , Up:
-

4.3 File Refs

+

5.3 File Refs

Refs are unique identifiers for files. Each note can only have 1 ref. For example, a note for a website may contain a ref: diff --git a/manual/Getting-Started.html b/manual/Getting-Started.html index b516dd5..2f8846b 100644 --- a/manual/Getting-Started.html +++ b/manual/Getting-Started.html @@ -67,7 +67,7 @@ Next: -

3 Getting Started

+

4 Getting Started

This short tutorial describes the essential commands used in Org-roam, to help you get started. diff --git a/manual/Graph-Options.html b/manual/Graph-Options.html index c987cff..b50b1b2 100644 --- a/manual/Graph-Options.html +++ b/manual/Graph-Options.html @@ -67,7 +67,7 @@ Next:

-

9.1 Graph Options

+

10.1 Graph Options

Graphviz provides many options for customizing the graph output, and Org-roam supports some of them. See https://graphviz.gitlab.io/_pages/doc/info/attrs.html for customizable options.

diff --git a/manual/Graphing.html b/manual/Graphing.html index f17075f..5167584 100644 --- a/manual/Graphing.html +++ b/manual/Graphing.html @@ -67,7 +67,7 @@ Next: -

9 Graphing

+

10 Graphing

Org-roam provides graphing capabilities to explore interconnections between notes. This is done by performing SQL queries and generating images using diff --git a/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html b/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html index 1e01d19..430eac0 100644 --- a/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html +++ b/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html @@ -66,7 +66,7 @@ Up: FAQ   [ -

14.1 How do I have more than one Org-roam directory?

+

15.1 How do I have more than one Org-roam directory?

Emacs supports directory-local variables, allowing the value of ‘org-roam-directory’ to be different in different directories. It does this by diff --git a/manual/Index-File.html b/manual/Index-File.html index 5b370ee..09f5bd4 100644 --- a/manual/Index-File.html +++ b/manual/Index-File.html @@ -67,7 +67,7 @@ Up: Na

-

7.1 Index File

+

8.1 Index File

As your collection grows, you might want to create an index where you keep links to your main files. diff --git a/manual/Installation-_00281_0029.html b/manual/Installation-_00281_0029.html index 7402260..3d177fd 100644 --- a/manual/Installation-_00281_0029.html +++ b/manual/Installation-_00281_0029.html @@ -67,7 +67,7 @@ Next:

-

11.2 Installation

+

12.2 Installation

To enable Org-roam’s protocol extensions, you have to add the following to your init file:

diff --git a/manual/Installation.html b/manual/Installation.html index 6d5bd41..80a5c79 100644 --- a/manual/Installation.html +++ b/manual/Installation.html @@ -26,7 +26,7 @@ General Public License for more details. - +