Hi everyone,
Since lists have been introduced into Offpunk, I’ve started to use them
more and more as a way to take notes about what I was reading on line.
To the point where half my zettelkasten was now saved into offpunk, with
some bits duplicated in my "normal" zettelkasten.
I’ve been wondering if offpunk could become my full zettelkasten and
implemented support of "notes" in a branch as an experiment.
It worked so great that my zettelkasten is now already fully into
Offpunk.
But the implementation sucks. Notes are so similar to lists that it’s a
bit weird to have the two concepts. Also, I find myself in the position
of making functions to convert notes to lists and lists to notes why
trying to avoid name collision.
That’s why I think I’ve learned from this experiment that notes and
lists should be only one concept. The only real differences between
notes and lists:
- notes are not updated and links not parsed during sync.
- "archive" has no effect on the content of notes.
- when accessed using the "note" command, you immediately go into edit
mode
I will thus start the development of Offpunk 3.0 with the following
changes:
- "lists" will be migrated to a larger "notes" concept.
- $XDG_LOCAL_SHARE/offpunk/lists -> $XDG_LOCAL_SHARE/offpunk/notes
(that’s will be a big change for those interacting directly with the
folder. May a symlink could be done)
- by default, a file in "notes" is a note.
- current "normal" lists will become "refreshed" or "lists" (or "normal"
?) (this is will be the only visible user-facing change for users of
lists: there will be a "#refreshed" in the title, like #frozen and
#subscribed
- "frozen" and "subscribed" lists will not change
- all the list/note code will be refactored into a separate tool which
allows you to use your zettelkasten without being in offpunk. What
name should it be ? notepnk? zttlpnk? any idea?
- a new "edit" command will allow to edit the current note/list (and
return an error if viewing anything else)
- a new "note" command which creates a note or edit an existing one or,
without parameter, show a "zettelkasten homepage" with links to your
existing notes and a configurable header (using "edit")
Appart from the zettelkasten/note code, 3.0 should also add support for
the git protocol and, hopefully, integration with unmerdify (which will
requires the git protocol). There will be several beta.
I plan to release 2.6 soon with all unreleased changes before switching
to 3.0 mode.
This might look like everything is already decided but I’m completely
open to feedback and discussion. This "zettelkasten" feature was not
convincing at all for me until I did this experiment and really liked it
on a day to day basis. It also highlighted that lists and notes should
really be kept a single concept.
Looking forward to read you about all of that,
-- Ploum - Lionel Dricot
Blog: https://www.ploum.net
Bikepunk: https://bikepunk.fr/
Ploum wrote:
> I’ve been wondering if offpunk could become my full zettelkasten> and implemented support of "notes" in a branch as an experiment.> > It worked so great that my zettelkasten is now already fully into > Offpunk.
I have never used lists or notes in offpunk, but for many years I have been on the lookout for a good textbased zettelkasten thing, so this sounds interesting. You have my attention.
> What name should it be ? notepnk? zttlpnk? any idea?
I can only speak for myself, but the larger the edit distance is to the meaning or pronunciation, the less likely I am to (1) start using it, and (2) keep using it (because I can never remember what vowels or consonants to omit).
IMHO: Just call it notepunk, listpunk or zettelpunk (or similar), and if people think it's too long to work with in the CLI they can make an alias or a symlink.
You could argue that I can just make an alias or symlink from, say, zttlpnk to zettelpunk, but just like it's curteous to write out the full name the first time you introduce an abbreviation, I think it's more user friendly to use e.g. zettelpunk for the name on disk. One day I will find a command called sltbf in /usr/bin and I will think “wtf is this?” and start searching around. Better start with the immediately readable and easily pronuncible slartibartfast and then alias it to sltbf if I can't be arsed to type the full command name.
Just my two eurocents.
Cheers,
--
Kʟᴀᴜꜱ Aʟᴇxᴀɴᴅᴇʀ Sᴇɪꜱᴛʀᴜᴘ 🇩🇰
Le 25 fév 18 10:59, Klaus Alexander Seistrup a écrit :
>Ploum wrote:>>You could argue that I can just make an alias or symlink from, say, >zttlpnk to zettelpunk, but just like it's curteous to write out the >full name the first time you introduce an abbreviation, I think it's >more user friendly to use e.g. zettelpunk for the name on disk. One day >I will find a command called sltbf in /usr/bin and I will think “wtf is >this?” and start searching around. Better start with the immediately >readable and easily pronuncible slartibartfast and then alias it to >sltbf if I can't be arsed to type the full command name.
Do you suggest that I rename opnk to openk ? (I found myself typing the
later most of the time and having to correct it in my shell)
-- Ploum - Lionel Dricot
Blog: https://www.ploum.net
Bikepunk: https://bikepunk.fr/
Ploum asked:
> Do you suggest that I rename opnk to openk ?
From the commands that get installed I have only ever used “offpunk”, and frankly I thought that “opnk” was an abbreviation of “offpunk”. :D
This case accentuates what I wrote about omitting arbitrary letters from commands names. ;)
So yes, indeed I do. :)
--
Kʟᴀᴜꜱ Aʟᴇxᴀɴᴅᴇʀ Sᴇɪꜱᴛʀᴜᴘ 🇩🇰