commit 072f176cfbeab734c3b18424a8d781c25bbdcab6 Author: Nickiel12 Date: Thu Oct 12 18:03:01 2023 -0700 chrono_track instructional diff --git a/render_all.sh b/render_all.sh new file mode 100755 index 0000000..bed7099 --- /dev/null +++ b/render_all.sh @@ -0,0 +1 @@ +pandoc --css=file:/home/nixolas/Documents/static_pages/templates/style.css -s --embed-resource -f markdown+smart --toc --metadata pagetitle="Chrono Track" --to html5 ./src/chrono_track.md -o output/chrono_track.html diff --git a/src/chrono_track.md b/src/chrono_track.md new file mode 100644 index 0000000..043089d --- /dev/null +++ b/src/chrono_track.md @@ -0,0 +1,71 @@ + +# Chrono Track User Manual +Welcome not so weary traveler! Odds are pretty high that you had no issue finding this, because if you *did* find it, odds are the creator gave it to you. + +## Credential file +The credential file for this script, looks like this: + +```toml +user="TheUserName" +pswd="theworldsmostsecurepasswordbecauseitislong" +email_addr="destination_addr@example.com" +primary_note_id="id of the source note" +logging_note_id="id of the output note" +server_url="the base domain of the server you are using" +``` + +Put your logon username (not your display name) into the first line, your logon password on the second line, and the email address you wish to recieve emails on line three. + +For the next part, you need to create two notes in your notes nextcloud. [See below for more information on actually setting it up](#setting-up-your-source-note). This section just shows how to get the ID. + +### Getting a note's ID +To get the ID of your notes, simply log into your nextcloud account, go to the notes tab, and navigate to the note you wish to get the id of. Then look at the URL, and grab the string of numbers at the end, and put that into the template above! + +Simply do this for both of the notes you wish to use. + +![URL Example with note id circled](file:./src/chrono_track/url-note-id-example.png) + +## Setting up your source note +The source note, is the important one that the user interacts with. If you are the user, then yes! I am talking about you. + +To set up the source note, all you need to know, is that Chrono Track ignores all lines except for checkboxes (`- [ ]` in markdown). So a source note might look like this! + +(Note: The title of the note does not matter) + +``` +- [ ] Item 1 +- [ ] Item 2 +This line is ignored! But quillpad will automatically convert it into a checklist item. +``` + +Because of the quillpad issue, I personally would advise that you only put checklist items in this file (lines starting with the checklist markdown mark `- [ ]`). If you don't use quillpad, and are using something that does support checking items in non-list-only files, congratulations you lucky person! Ignore this line. + +## Setting up your output note +This file is 90% managed by Chrono Track, so you should only need to touch it once, and forget about it. + +To start the file, please put the following: + +```markdown +*Last Updated* +# Automatically Generated +``` + +And that's it. In fact, you could go even more minimalistic, because this is all that it checks for: +```markdown +*Last Updated +# +``` + +# Warranty Agreement + +*Disclaimer: The Dubiously Digitized Dreamcatcher© Software Warranty Depletion Expedition* + +*Congratulations on embarking on this software odyssey! We must inform you that this product, the Dubiously Digitized Dreamcatcher©, journeys through the labyrinth of warranty obfuscation. Herein, we are boldly committed to a perpetually transient warranty policy, which may challenge your very grasp of reality.* + +*Initially, our warranty is as solid as a fleeting quantum particle, here and not here simultaneously. Over time, it metamorphoses into a spectral unicorn tap-dancing on the event horizon of a cosmic black hole.* + +*Intriguingly, your warranty might transform into a probability cloud of wandering gnomes with abacuses, calculating the odds of a one-winged butterfly performing a symphony. Eventually, your warranty becomes a palindrome of gibberish.* + +*Remember, we take pride in our commitment to the inexplicable. Use this software at your own risk, and may the warranty force be ever in your favor.* + +Thank you ChatGPT, that will do nicely diff --git a/src/chrono_track/url-note-id-example.png b/src/chrono_track/url-note-id-example.png new file mode 100644 index 0000000..ebd662d Binary files /dev/null and b/src/chrono_track/url-note-id-example.png differ diff --git a/templates/style.css b/templates/style.css new file mode 100644 index 0000000..5c0f1a1 --- /dev/null +++ b/templates/style.css @@ -0,0 +1,329 @@ +html{ + font-family:sans-serif; + -ms-text-size-adjust:100%; + -webkit-text-size-adjust:100% +} +body{ + background-color: #11111b; + color: #cdd6f4; + margin:0; +} +a{ + color: #a6d189; + background:transparent +} +a:active,a:hover{ + outline:0 +} +b,strong{ + font-weight:bold +} +h1{ + color: #eba0ac; + font-size:2em; + margin:0.67em 0 +} +small{ + font-size:80% +} +sub,sup{ + color: #b5bfe2 + font-size:75%; + line-height:0; + position:relative; + vertical-align:baseline +} +sup{ + top:-0.5em +} +sub{ + bottom:-0.25em +} +img{ + border:0 +} +hr{ + -moz-box-sizing:content-box; + box-sizing:content-box; + height:0; +} +pre{ + overflow:auto +} +code,kbd,pre,samp{ + font-family:monospace, monospace; + font-size:1em; + color: #414559; +} +textarea{ + overflow:auto +} +table{ + border-collapse:collapse; + border-spacing:0 +} +td,th{ + padding:0 +} +body,code,tr.odd,tr.even,body{ + line-height:1.3; + text-align:justify; + -moz-hyphens:auto; + -ms-hyphens:auto; + -webkit-hyphens:auto; + hyphens:auto +} +@media (max-width: 400px){ + body{ + font-size:12px; + margin-left:10px; + margin-right:10px; + margin-top:10px; + margin-bottom:15px + } +} +@media (min-width: 401px) and (max-width: 600px){ + body{ + font-size:14px; + margin-left:10px; + margin-right:10px; + margin-top:10px; + margin-bottom:15px + } +} +@media (min-width: 601px) and (max-width: 900px){ + body{ + font-size:15px; + margin-left:100px; + margin-right:100px; + margin-top:20px; + margin-bottom:25px + } +} +@media (min-width: 901px) and (max-width: 1800px){ + body{ + font-size:17px; + margin-left:200px; + margin-right:200px; + margin-top:30px; + margin-bottom:25px; + max-width:800px + } +} +@media (min-width: 1801px){ + body{ + font-size:18px; + margin-left:20%; + margin-right:20%; + margin-top:30px; + margin-bottom:25px; + max-width:1000px + } +} +p{ + margin-top:10px; + margin-bottom:18px +} +em{ + font-style:italic +} +strong{ + font-weight:bold +} +h1,h2,h3,h4,h5,h6{ + font-weight:bold; + padding-top:0.25em; + margin-bottom:0.15em +} +header{ + line-height:2.475em; + padding-bottom:0.7em; + border-bottom:1px solid #bbb; + margin-bottom:1.2em +} +header>h1{ + border:none; + padding:0; + margin:0; + font-size:225% +} +header>h2{ + border:none; + padding:0; + margin:0; + font-style:normal; + font-size:175% +} +header>h3{ + padding:0; + margin:0; + font-size:125%; + font-style:italic +} +header+h1{ + border-top:none; + padding-top:0px +} +h1{ + border-top:1px solid #bbb; + padding-top:15px; + font-size:150%; + margin-bottom:10px +} +h1:first-of-type{ + border:none +} +h2{ + font-size:125%; + font-style:italic +} +h3{ + font-size:105%; + font-style:italic +} +hr{ + border:0px; + border-top:1px solid #bbb; + width:100%; + height:0px +} +hr+h1{ + border-top:none; + padding-top:0px +} +ul,ol{ + font-size:90%; + margin-top:10px; + margin-bottom:15px; + padding-left:30px +} +ul{ + list-style:circle +} +ol{ + list-style:decimal +} +ul ul,ol ol,ul ol,ol ul{ + font-size:inherit +} +li{ + margin-top:5px; + margin-bottom:7px +} +q,blockquote,dd{ + font-style:italic; + font-size:90% +} +blockquote,dd{ + quotes:none; + border-left:0.35em #bbb solid; + padding-left:1.15em; + margin:0 1.5em 0 0 +} +blockquote blockquote,dd blockquote,blockquote dd,dd dd,ol blockquote,ol dd,ul blockquote,ul dd,blockquote ol,dd ol,blockquote ul,dd ul{ + font-size:inherit +} +a,a:link,a:visited,a:hover{ + color:inherit; + text-decoration:none; + border-bottom:1px dashed #111 +} +a:hover,a:link:hover,a:visited:hover,a:hover:hover{ + border-bottom-style:solid +} +a.footnoteRef,a:link.footnoteRef,a:visited.footnoteRef,a:hover.footnoteRef{ + border-bottom:none; + color:#666 +} +code{ + font-family:"Source Code Pro","Consolas","Monaco",monospace; + font-size:85%; + background-color:#ddd; + border:1px solid #bbb; + padding:0px 0.15em 0px 0.15em; + -webkit-border-radius:3px; + -moz-border-radius:3px; + border-radius:3px +} +pre{ + margin-right:1.5em; + display:block +} +pre>code{ + display:block; + font-size:70%; + padding:10px; + -webkit-border-radius:5px; + -moz-border-radius:5px; + border-radius:5px; + overflow-x:auto +} +blockquote pre,dd pre,ul pre,ol pre{ + margin-left:0; + margin-right:0 +} +blockquote pre>code,dd pre>code,ul pre>code,ol pre>code{ + font-size:77.77778% +} +caption,figcaption{ + font-size:80%; + font-style:italic; + text-align:right; + margin-bottom:5px +} +caption:empty,figcaption:empty{ + display:none +} +table{ + width:100%; + margin-top:1em; + margin-bottom:1em +} +table+h1{ + border-top:none +} +tr td,tr th{ + padding:0.2em 0.7em +} +tr.header{ + border-top:1px solid #222; + border-bottom:1px solid #222; + font-weight:700 +} +tr.odd{ + background-color:#eee +} +tr.even{ + background-color:#ccc +} +tbody:last-child{ + border-bottom:1px solid #222 +} +dt{ + font-weight:700 +} +dt:after{ + font-weight:normal; + content:":" +} +dd{ + margin-bottom:10px +} +img{ + display:block; + margin:0px auto; + padding:0px; + max-width:100% +} +figcaption{ + margin:5px 10px 5px 30px +} +.footnotes{ + color:#666; + font-size:70%; + font-style:italic +} +.footnotes li p:last-child a:last-child{ + border-bottom:none +} +