kudrykv / latex-yearly-planner

Digital planner for Supernote and ReMarkable // Support Ukraine 🇺🇦 https://savelife.in.ua/en
https://github.com/kudrykv/latex-yearly-planner/discussions
MIT License
1.1k stars 160 forks source link

Add description of what parts of file names are #85

Open Bootstrap360 opened 1 year ago

Bootstrap360 commented 1 year ago

Hello Kudrykv,

Thank you for your work and the releases here: https://github.com/kudrykv/latex-yearly-planner/releases/tag/v0.0.8

Could you please add a table in the readme of what all the pieces of the file names are?

For example

Name Component Definition
Breadcrum Navigation bar at the top of daily page is a bread crumb of where the pages is
dotted Notes on the daily page are a grid of dots as opposed to lines

...

I was not able to figure out what ampm means, or the difference between dailycal

kudrykv commented 1 year ago

Hello!

Yeah, I guess that would make sens.e

There are a few parameters.

rm2.breadcrumb.lined.default.ampm.sun.dailycal.2021.pdf
^^^ ^^^^^^^^^^ ^^^^^ ^^^^^^^ ^^^^ ^^^ ^^^^^^^^ ^^^^
|   |          |     |       |    |   |        |
|   |          |     |       |    |   |         \
|   |          |     meant   |    |    \          - year
|   |          |     to      |    |     \
|   |          |     mean    |    |       - monthly calendar is present
|   |          |     smth    |     \        on the daily page
|   |          |     but     |      \
|   |          |     it       \      \
|   |          |     does not  \       - week start at Sunday (default is Monday)
|   |          |                \
|   |           \                \
|   |            \                 - time format on daily pages is AM/PM
|    \            \                  (default is 24 hour format)
|     \            \
|      \             - lined notes; other option
|       \              is dotted notes
|        \
|         \
|           - template name. Breadcrumb has navigation on top;
 \            MOS (months on side) has quarters and months navigation on the side
  \
   \
     - device abbreviation

If there is no .sun. somewhere, then week starts on Monday. If there is no .ampm., then it's 24-hour format.

There are four "qualitative" configuration options:

Bootstrap360 commented 1 year ago

Thanks @kudrykv, What does "smth" mean in "default <- meant to mean smth but it does not"

kudrykv commented 1 year ago

it meant to mean something, but it does not Currently, the default keyword there means nothing.