Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please define the file format #17

Open
lquenti opened this issue Aug 15, 2022 · 1 comment
Open

Please define the file format #17

lquenti opened this issue Aug 15, 2022 · 1 comment

Comments

@lquenti
Copy link

lquenti commented Aug 15, 2022

Could you formally document how the expected file format for kanbans should look like?

Would be great, both for auxiliary tools and possible migration if the project diverges with the personal needs

@PlankCipher
Copy link
Owner

Not really sure what you mean by "formally". Do you mean as in a wiki or something?

If it helps, here is how it's documented in the man page:

FILES
       $HOME/.local/share/kabmat/data
              Main data file (see NOTES for info about syntax in this file).
 
       $HOME/.local/share/kabmat/data_bkp
              A  backup  file  to  which content of main data file is copied before writing anything into main
              date file to minimize data loss on crashes.
 
NOTES
       The syntax of the data file simply depends on indentation. Here is how. (The start and end  of  a  line
       are marked with ^ and $ respectively for demo purposes only)
 
       ^a board's name$
 
       ^ a column's name in that board$
 
       ^  a card's content in that column$
 
       ^   -a not done checklist item in that card$
 
       ^   +a done checklist item in that card$
 
       ^    Description of this card.$
 
       ^    The description of the card can be multi-line$
 
       ^another board starts here$
 
       ^ and so on...$
 
       Each line is an entry. A board's name has no spaces before it. A column's title has 1. A card's content
       has 2. A card's checklist item has 3. A card's description has 4.
 
       A checklist item is marked not done by adding a - before its content and marked done by adding + before
       it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants