R/scratch.R

In smingerson/jotdown: Flexible note-taking system using (R)markdown

# The first step is creating a note file.
# This takes a file name, whether it is a bundle, an extension,
# a slug, a single category, multiple tags

# Once some note files exist, we want to be able to organize
# them into a searchable blog at will.

# Too, all data should be easily represented within R for
# easily manipulation.

# What's the API for viewing? notes_as_book(spec = NULL, path = NULL, ordering = NULL)
# notes_as_blog(spec = NULL, path = NULL, ordering = NULL)

# Allow building of spec from source/major/<files> to allow easier reorganization
# than editing a bunch of files by hand.

# A spec is a tibble with at least columns (filename, category).
# build_note_spec is how you get the initial table

# organize_notes will take a spec and manipulate the viewing folder accordingly.

# We want to allow convenient searching of notes by book/blog, but how do
# make those notes simple to edit? Run `edit_note(name)`, embed this command
# into each rendered note at the top.

# Loading of .yaml -- look for .jotdown.y(a)ml in directory. You can change
# the name by setting jotdown.config.y(a)ml prior to package load.

# Allows convenient adding/editing of notes in Github!

# How would to-do's work?

# What would a config yaml look like?

# strict: true
# major: "category"
# minor: "tag"
# major_exclusive : true
# major_default = "Miscellaneous"
# default_format: "book"
# default_to_bundle: false
# date_format: "YYYY-mm-dd"
#

# What options need to be included
# jotdown.project.default
# jotdown.project.*

# API
# new_note(name, major = NULL, minor = NULL, bundle = NULL, subdir = NULL)
# edit_note(name)
# change_note(name, major, minor) # for simply modifying tags
# list_notes(major, minor) #dir tree structure?
# notes_as_data()


# Package: requires bookdown
#  On package setup, create jotdown subfolder. all files will be kept here.
# Special files will be: index.rmd