fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-18 03:58:32 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add section on changing a journal type and clean up work from previous commit

Browse source
This commit is contained in:
Micah Jerome Ellison 2021-09-11 16:08:21 -07:00
parent 3f8f14cf8f
commit 697e54a160
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/journal-types.md
View file

@ -5,15 +5,13 @@
- a single text file (encrypted or otherwise) - a single text file (encrypted or otherwise)
- a folder structure organized by date containing unencrypted text files - a folder structure organized by date containing unencrypted text files
- the DayOne Classic format, which is a folder structure containing - the DayOne Classic format
There is no need to specify what type of journal you'd like to use. Instead, There is no need to specify what type of journal you'd like to use. Instead,
`jrnl` will automatically detect the journal type based on whether you're `jrnl` will automatically detect the journal type based on whether you're
referencing a file or a folder in your [config file](advanced.md), referencing a file or a folder in your [config file](advanced.md),
and if it's a folder, whether or not DayOne Classic content exists in it. and if it's a folder, whether or not DayOne Classic content exists in it.
## Single File ## Single File
The single file format is the most flexible, as it can be [encrypted](encryption.md). The single file format is the most flexible, as it can be [encrypted](encryption.md).
To use it, enter any path that is a file or does not already exist. You can To use it, enter any path that is a file or does not already exist. You can
@ -38,13 +36,26 @@ are creating a single file journal instead, and it will create a file at that pa
Folder journals can't be encrypted. Folder journals can't be encrypted.
## Day One Classic ## Day One Classic
`jrnl` supports the original data format used by DayOne. It's very similar to the folder `jrnl` supports the original data format used by DayOne. It's similar to the folder
journal format, except it's identified by either of these characteristics: journal format, except it's identified by either of these characteristics:
* the folder has a `.dayone` extension * the folder has a `.dayone` extension
* the folder has a subfolder named `entries` * the folder has a subfolder named `entries`
This is not to be confused with the DayOne 2.0 format, which is very different. This is not to be confused with the DayOne 2.0 format, [which is very different](https://help.dayoneapp.com/en/articles/1187337-day-one-classic-is-retired).
!!! note !!! note
DayOne Classic journals can't be encrypted. DayOne Classic journals can't be encrypted.
## Changing your journal type
You can't simply modify a journal's configuration to change its type. Instead,
define a new journal as the type you'd like, and use
[piping](https://en.wikipedia.org/wiki/Redirection_(computing)#Piping)
to export your old journal as `txt` to an import command on your new journal.
For instance, if you have a `projects` journal you would like to import into
a `new` journal, you would run the following after setting up the configuration
for your `new` journal:
```
jrnl projects --format txt | jrnl new --import
```