unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: "Paul W. Rankin" <hello@paulwrankin.com>
To: help-gnu-emacs@gnu.org
Subject: Emulating Scrivener's binder feature
Date: Mon, 01 Apr 2019 18:09:48 +1000	[thread overview]
Message-ID: <m2h8bim9ir.fsf@paulwrankin.com> (raw)

Hello Emaczens,

I've started a new Emacs package to try and emulate the behaviour of Scrivener's
binder feature.

A buffer in a side window would display the current project not unlike
dired-sidebar -- each file in the project occupying a single line. The ordering
of these files should be arbitrary (i.e. the user may reorder the files) and
this project structure should be persistent across sessions. Global keybindings
should allow navigation from a file in the current project to the next/previous
file in this structure. The user should (eventually) be able to mark a selection
of files and concatenate/export these into a master output.

The idea would be to have a .binder file in the top directory of the project.
This file should be human-readable. Each line in this file should be a file path
relative to the .binder file. Metadata relating to each file is stored below the
file, terminating at the next file or EOF.

Metadata could be: Tags beginning with ":" e.g. :tag1 :tag2 :toast :piglet.
Multi-line notes prefixed with ">" like Markdown blockquotes. Comments start
with "#". Blank lines are ignored.

An example .binder file might look like this:

    # This is a comment

    The Problem of Space.txt
    :kirin
    First Attempt.txt
    :noomi
    > Intro to Noomi.
    An Angry Driver.txt
    :cameo

    > Uncle Bob could do this?

    Archive/Other Options.txt
    Working Together.txt
    :act3 :revised
    > Putting ego aside, Kirin puts all his faith in Noomi's ability to judge
    > the space from outside the truck. Little by little, they make it in.

Someone might suggest that this info all be stored as lisp objects in
.dir-locals.el but my thinking is that a .binder file could be cross-platform
(i.e. also work outside of Emacs).

Before I go to far,

Question 1: Has someone already made something like this? I don't want to
reinvent the wheel...

Question 2: Any suggestions, pitfalls or edge cases?

Regards,
Paul

p.s. please Reply-All, I'm not on the list.

--
https://www.paulwrankin.com



             reply	other threads:[~2019-04-01  8:09 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-01  8:09 Paul W. Rankin [this message]
2019-04-01 15:06 ` Emulating Scrivener's binder feature Drew Adams
2019-04-03  9:34   ` Paul W. Rankin
2019-04-01 15:27 ` Skip Montanaro
2019-04-01 16:57 ` Marcin Borkowski
2019-04-03  9:59   ` Paul W. Rankin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m2h8bim9ir.fsf@paulwrankin.com \
    --to=hello@paulwrankin.com \
    --cc=help-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).