Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 5.57 KB

README.md

File metadata and controls

102 lines (74 loc) · 5.57 KB
Raw

This repository contains a self-documenting Zettel template for use with a software implementation of the Zettelkasten Method. For software configuration notes, definitions of terms, and more examples, see the Zettel Wiki. The Zettelkasten Method is documented online at Introduction to the Zettelkasten Method on the Zettelkasten.de site and in the Zettelkasten.de forum. If you find the terminology of literature notes and permanent notes vague or confusing, it's not your fault--see From Fleeting Notes to Project Notes. Recommended: Tinderbox Meetup April 23, 2023 Video: On ZettelKasten with Sascha Fast from Zettelkasten.de. Also, see Note Taking Traditions by Chris Aldrich.

NOTE: As of October 2024, I switched to Obsidian version 1.6.7 from Zettlr 3.2.2. Zettlr was too slow to work with on my Windows 11 system. See the Zettel Wiki for updated software configuration notes, which are under construction as I bring them up to date.

NEW: Guidelines for Maintaining a Digital Zettelkasten. These are some of the guidelines I follow.

This README.md and the Zettek wiki are licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. CC BY-SA 4.0 2022-2023 F Lengyel. You don't need to credit me if your notes instantiate the template. If you copy and publish this template or derive a template from this one and publish it, then CC BY-SA 4.0 applies.

The code is licensed under the GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007

---
# Version: 2024.10.12.1
# This self-documenting Zettel template specifies the format of 
# a Zettel suitable for a digital Zettelkasten. The Zettel is
# organized as a Markdown file, beginning with this YAML 
# frontmatter followed by self-documenting Markdown sections 
# in the order of presentation. The YAML frontmatter contains
# commands to Zettlr, Pandoc, and Obsidian and includes, 
# at minimum, the following variables: `id:`. `title:` and 
# `reference-section-title:` 

id: ZTEMP.1.0.24.1012

# The value of the `id:` variable is a the unique, immutable ID of the Zettel.  
# Immutable, unique IDs may have different formats, according to personal preference. 
# Timestamps are a popular choice, followed by Folgezettel. 

title: "ZTEMP.1.0.24.0228 H1 header title - Zettel Template"

# The value of the `title:` variable is a quoted string, 
# consisting of a unique, immutable ID, in this case 
# `ZTEMP.1.0.24.0228`, followed by the H1 header title, in this case
# "Zettel Template"

reference-section-title: References

# The `reference-section-title:` variable is a command to Pandoc.
# If Zettel is exported through Pandoc and the Zettel body includes 
# Pandoc-style citations, the `reference-section-title:` variable 
# will cause Pandoc to add a References section with citations to the
# end of the exported document. 
---

H1 header title - Zettel Template

# H1 header title - Zettel Template

The Zettel body begins with the H1 header and ends immediately before the SEE ALSO section below. . In my system, the H1 header is the value of the title: YAML variable minus the unique, immutable ID; however, this choice is optional. Titles aren't immutable, unlike IDs. Bob Doto writes that a note title "should be a declarative statement rather than a descriptor" (Doto 2024, 56).

Definitions

Reference Element Types

  • WikiLink: A markdown link within Zettels, enclosed in double brackets (e.g., [[UniqueID]] Zettel Title), used to interlink notes.
  • Title-only WikiLink: A WikiLink followed immediately by the title, without extra annotations.
  • Hashtags: For thematic categorization, typically used in the SEE ALSO section.
  • Pandoc citations: References in the form [@citeKey] are linked to a citation database like Zotero.

Types of Notes in Zettelkasten

  • Single-focus Zettels: Focus on one main idea or topic.
  • Structure Notes: Outline and connect Single-focus Zettels under broader themes; contain sections with annotated WikiLinks.
  • Index Notes: Navigational tools marked by IDs starting with 0000.0000.0; annotated with their title only.

SEE ALSO Section:

  • Separates additional links from the main content to maintain focus.
  • Contains title-only WikiLinks not directly tied to the Zettel's central theme, including:
  • Index Note WikiLinks: For navigation and categorization. See the complete list of index note wikilinks below.
  • Distantly Related Zettel Links: Provide additional context or suggest further research.
  • Hashtags and Metadata: Aid in organizing and retrieving notes.

References:

Lists external sources or additional reading. This section is optional if Pandoc citations are used, as Pandoc will generate it.

SEE ALSO

[[0000.0000.0000]] INDEX
[[0000.0000.0ABC]] A-B-C
[[0000.0000.0DEF]] D-E-F
[[0000.0000.0GHI]] G-H-I
[[0000.0000.0JKL]] J-K-L
[[0000.0000.0MNO]] M-N-O
[[0000.0000.0PQR]] P-Q-R
[[0000.0000.0STU]] S-T-U
[[0000.0000.0VWX]] V-W-X
[[0000.0000.00YZ]] Y-Z
[[0000.0000.0009]] 0-9

#replace #these #hashtags

References

  • Ahrens, Sönke. 2017. How to Take Smart Notes. North Charleston, SC: CreateSpace.
  • Doto, Bob. 2024. A System for Writing. Old New Traditions.