Compare commits
16 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
f8edb70065 | ||
![]() |
218705bdc9 | ||
![]() |
48a8789c4d | ||
![]() |
48ab7f9514 | ||
![]() |
f2d9a2abe6 | ||
![]() |
cb55a967d0 | ||
![]() |
52c0daedbb | ||
![]() |
09b856488b | ||
![]() |
9218a83d41 | ||
![]() |
a896244367 | ||
![]() |
ec83de9978 | ||
![]() |
9a70b67af7 | ||
![]() |
86441e9618 | ||
![]() |
2f53a8f616 | ||
![]() |
c335597b57 | ||
![]() |
a7bdd2397e |
13
README.md
13
README.md
@@ -19,7 +19,7 @@ Some basic knowledge of [TiddlyWiki](https://tiddlywiki.com)
|
|||||||
|
|
||||||
|
|
||||||
Documentation / Installation
|
Documentation / Installation
|
||||||
============================
|
----------------------------
|
||||||
|
|
||||||
Find a live version of the edition on the web with further instructions
|
Find a live version of the edition on the web with further instructions
|
||||||
at https://sobjornstad.github.io/tzk/.
|
at https://sobjornstad.github.io/tzk/.
|
||||||
@@ -28,3 +28,14 @@ You can find the documentation for the CLI
|
|||||||
versioning with Git,
|
versioning with Git,
|
||||||
and creating public and other derivative versions of the wiki)
|
and creating public and other derivative versions of the wiki)
|
||||||
at https://tzk.readthedocs.io/en/latest/.
|
at https://tzk.readthedocs.io/en/latest/.
|
||||||
|
|
||||||
|
|
||||||
|
Video walkthrough
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Since tzk is still in an alpha state,
|
||||||
|
general instructions on how to use it are somewhat lacking at the moment.
|
||||||
|
To fill in the gap in the meantime,
|
||||||
|
I recorded an hour-long walkthrough showing how you might take notes using tzk;
|
||||||
|
you can select individual sections to watch if that's longer than you want.
|
||||||
|
[Watch the video on YouTube](https://www.youtube.com/watch?v=9X_T-DVie8o).
|
||||||
|
@@ -5,7 +5,7 @@
|
|||||||
2. Update version numbers:
|
2. Update version numbers:
|
||||||
`setup.py`,
|
`setup.py`,
|
||||||
`cli_docs/conf.py`,
|
`cli_docs/conf.py`,
|
||||||
`util.py`.
|
`tzk/util.py`.
|
||||||
3. Push changes to GitHub.
|
3. Push changes to GitHub.
|
||||||
Check that RTD and GitHub Pages update as desired
|
Check that RTD and GitHub Pages update as desired
|
||||||
(https://tzk.readthedocs.io/en/latest/,
|
(https://tzk.readthedocs.io/en/latest/,
|
||||||
|
@@ -18,9 +18,9 @@ copyright = '2021 Soren Bjornstad'
|
|||||||
author = 'Soren Bjornstad'
|
author = 'Soren Bjornstad'
|
||||||
|
|
||||||
# The short X.Y version
|
# The short X.Y version
|
||||||
version = "0.1.0"
|
version = "0.1.4"
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = "0.1.0"
|
release = "0.1.4"
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
@@ -234,8 +234,6 @@ Error message and password prompt
|
|||||||
|
|
||||||
<li>$:/config/EditTabIndex</li>
|
<li>$:/config/EditTabIndex</li>
|
||||||
|
|
||||||
<li>$:/config/FileSystemPaths</li>
|
|
||||||
|
|
||||||
<li>$:/config/flibbles/relink/fields/bibliography</li>
|
<li>$:/config/flibbles/relink/fields/bibliography</li>
|
||||||
|
|
||||||
<li>$:/config/flibbles/relink/fields/description</li>
|
<li>$:/config/flibbles/relink/fields/description</li>
|
||||||
@@ -394,6 +392,8 @@ Error message and password prompt
|
|||||||
|
|
||||||
<li>$:/config/WikiParserRules/Inline/dash</li>
|
<li>$:/config/WikiParserRules/Inline/dash</li>
|
||||||
|
|
||||||
|
<li>$:/config/zettelkasten/Build/KillPhrases</li>
|
||||||
|
|
||||||
<li>$:/config/zettelkasten/copyright/Content</li>
|
<li>$:/config/zettelkasten/copyright/Content</li>
|
||||||
|
|
||||||
<li>$:/config/zettelkasten/copyright/InitialNotice</li>
|
<li>$:/config/zettelkasten/copyright/InitialNotice</li>
|
||||||
@@ -822,6 +822,8 @@ Error message and password prompt
|
|||||||
|
|
||||||
<li>$:/sib/Tools/TagReplace</li>
|
<li>$:/sib/Tools/TagReplace</li>
|
||||||
|
|
||||||
|
<li>$:/sib/Tools/Tray</li>
|
||||||
|
|
||||||
<li>$:/sib/Tools/Tray/Template</li>
|
<li>$:/sib/Tools/Tray/Template</li>
|
||||||
|
|
||||||
<li>$:/SiteSubtitle</li>
|
<li>$:/SiteSubtitle</li>
|
||||||
@@ -989,17 +991,6 @@ Error message and password prompt
|
|||||||
<div created="20200515033855017" modified="20200515033900734" tags="" title="$:/config/EditTabIndex" type="text/vnd.tiddlywiki">
|
<div created="20200515033855017" modified="20200515033900734" tags="" title="$:/config/EditTabIndex" type="text/vnd.tiddlywiki">
|
||||||
<pre>1</pre>
|
<pre>1</pre>
|
||||||
</div>
|
</div>
|
||||||
<div created="20200427015719697" modified="20200427020204931" tags="" title="$:/config/FileSystemPaths" type="text/vnd.tiddlywiki">
|
|
||||||
<pre>[is[system]removeprefix[$:/]addprefix[_system/]]
|
|
||||||
[tag[Template]tag[Meta]tag[Tool]addprefix[_meta/]]
|
|
||||||
[tag[Image]tag[Attachment]addprefix[media/]]
|
|
||||||
[tag[Journal]addprefix[journal/]]
|
|
||||||
[tag[Source]addprefix[source/]]
|
|
||||||
[tag[Sink]addprefix[sink/]]
|
|
||||||
[tag[PAO]addprefix[pao/]]
|
|
||||||
[tag[Place]addprefix[place/]]
|
|
||||||
[tag[Publication]tag[Class]addprefix[metasource/]]</pre>
|
|
||||||
</div>
|
|
||||||
<div created="20210606192417191" modified="20210606192216249" title="$:/config/flibbles/relink/fields/bibliography" type="text/vnd.tiddlywiki">
|
<div created="20210606192417191" modified="20210606192216249" title="$:/config/flibbles/relink/fields/bibliography" type="text/vnd.tiddlywiki">
|
||||||
<pre>list</pre>
|
<pre>list</pre>
|
||||||
</div>
|
</div>
|
||||||
@@ -1217,13 +1208,13 @@ github: https://github.com/sobjornstad/zettelkasten-sib</pre>
|
|||||||
<pre>hide</pre>
|
<pre>hide</pre>
|
||||||
</div>
|
</div>
|
||||||
<div created="20200913200724872" modified="20201120173215063" title="$:/config/ViewToolbarButtons/Visibility/$:/core/ui/Buttons/permalink" type="text/vnd.tiddlywiki">
|
<div created="20200913200724872" modified="20201120173215063" title="$:/config/ViewToolbarButtons/Visibility/$:/core/ui/Buttons/permalink" type="text/vnd.tiddlywiki">
|
||||||
<pre>hide</pre>
|
<pre>show</pre>
|
||||||
</div>
|
</div>
|
||||||
<div created="20200404141629548" creator="soren" modified="20200404141630712" modifier="soren" title="$:/config/ViewToolbarButtons/Visibility/$:/plugins/bimlas/locator/viewtemplate/open-in-sidebar" type="text/vnd.tiddlywiki">
|
<div created="20200404141629548" creator="soren" modified="20200404141630712" modifier="soren" title="$:/config/ViewToolbarButtons/Visibility/$:/plugins/bimlas/locator/viewtemplate/open-in-sidebar" type="text/vnd.tiddlywiki">
|
||||||
<pre>hide</pre>
|
<pre>hide</pre>
|
||||||
</div>
|
</div>
|
||||||
<div created="20210525001044166" modified="20210525000849030" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink" type="text/vnd.tiddlywiki">
|
<div created="20210525001044166" creator="soren" modified="20210922125743198" modifier="soren" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink" type="text/vnd.tiddlywiki">
|
||||||
<pre>show</pre>
|
<pre>hide</pre>
|
||||||
</div>
|
</div>
|
||||||
<div created="20210525001045047" modified="20210525000850061" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyTitleReference" type="text/vnd.tiddlywiki">
|
<div created="20210525001045047" modified="20210525000850061" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyTitleReference" type="text/vnd.tiddlywiki">
|
||||||
<pre>show</pre>
|
<pre>show</pre>
|
||||||
@@ -1240,6 +1231,9 @@ github: https://github.com/sobjornstad/zettelkasten-sib</pre>
|
|||||||
<div created="20201124030001841" modified="20201124030011884" title="$:/config/WikiParserRules/Inline/dash" type="text/vnd.tiddlywiki">
|
<div created="20201124030001841" modified="20201124030011884" title="$:/config/WikiParserRules/Inline/dash" type="text/vnd.tiddlywiki">
|
||||||
<pre>enable</pre>
|
<pre>enable</pre>
|
||||||
</div>
|
</div>
|
||||||
|
<div created="20210731165327653" modified="20210731173813193" title="$:/config/zettelkasten/Build/KillPhrases" type="text/vnd.tiddlywiki">
|
||||||
|
<pre></pre>
|
||||||
|
</div>
|
||||||
<div created="20210523151041802" creator="soren" modified="20210825142618069" modifier="soren" tags="" title="$:/config/zettelkasten/copyright/Content" type="text/vnd.tiddlywiki">
|
<div created="20210523151041802" creator="soren" modified="20210825142618069" modifier="soren" tags="" title="$:/config/zettelkasten/copyright/Content" type="text/vnd.tiddlywiki">
|
||||||
<pre>The ''text of my notes'', that is, most of the content of the wiki, is all-rights-reserved.
|
<pre>The ''text of my notes'', that is, most of the content of the wiki, is all-rights-reserved.
|
||||||
You are welcome to read, learn from, and link to all notes (click the hash icon in the upper-right to copy a link to any tiddler; keep in mind that currently public notes could become private in the future, though I try to avoid doing this).
|
You are welcome to read, learn from, and link to all notes (click the hash icon in the upper-right to copy a link to any tiddler; keep in mind that currently public notes could become private in the future, though I try to avoid doing this).
|
||||||
@@ -16051,22 +16045,38 @@ Info: CoreVersion parameter is needed for TiddlyWiki only!
|
|||||||
}
|
}
|
||||||
}</pre>
|
}</pre>
|
||||||
</div>
|
</div>
|
||||||
<div caption="Copy public Zettelkasten link" created="20201120172611922" creator="soren" description="Copy a link to this tiddler in the public Zettelkasten" list-after="$:/core/ui/Buttons/info" modified="20210825162715432" modifier="soren" tags="$:/tags/ViewToolbar" title="$:/sib/Buttons/CopyPublicZettelkastenLink" type="text/vnd.tiddlywiki">
|
<div caption="copy public link" created="20201120172611922" creator="soren" description="Copy a link to this tiddler in the public Zettelkasten" list-after="$:/core/ui/Buttons/info" modified="20210922125543768" modifier="soren" tags="$:/tags/ViewToolbar" title="$:/sib/Buttons/CopyPublicZettelkastenLink" type="text/vnd.tiddlywiki">
|
||||||
<pre>\whitespace trim
|
<pre>\whitespace trim
|
||||||
\define copier()
|
\define copier()
|
||||||
https://zettelkasten.sorenbjornstad.com/#$(tidTitle)$
|
https://zettelkasten.sorenbjornstad.com/#$(tidTitle)$
|
||||||
\end
|
\end
|
||||||
|
|
||||||
<$set name="tidTitle" value={{!!title}}>
|
<$set name="tidTitle" value={{!!title}}>
|
||||||
<$button message="tm-copy-to-clipboard" param=<<copier>> tooltip={{!!caption}} class=<<tv-config-toolbar-class>>>
|
<$button message="tm-copy-to-clipboard" param=<<copier>> tooltip={{$:/sib/Buttons/CopyPublicZettelkastenLink!!caption}} class=<<tv-config-toolbar-class>>>
|
||||||
|
<$list filter="[<tv-config-toolbar-icons>match[yes]]">
|
||||||
{{$:/core/images/permalink-button}}
|
{{$:/core/images/permalink-button}}
|
||||||
|
</$list>
|
||||||
|
<$list filter="[<tv-config-toolbar-text>match[yes]]">
|
||||||
|
<span class="tc-btn-text">
|
||||||
|
<$text text=" "/>
|
||||||
|
<$text text={{$:/sib/Buttons/CopyPublicZettelkastenLink!!caption}}/>
|
||||||
|
</span>
|
||||||
|
</$list>
|
||||||
</$button>
|
</$button>
|
||||||
</$set></pre>
|
</$set></pre>
|
||||||
</div>
|
</div>
|
||||||
<div caption="Copy tiddler title" created="20200419143537510" creator="soren" description="Copy the name of this tiddler to the clipboard" list-after="$:/core/ui/Buttons/info" modified="20210825162721583" modifier="soren" tags="$:/tags/ViewToolbar" title="$:/sib/Buttons/CopyTitleReference" type="text/vnd.tiddlywiki">
|
<div caption="copy tiddler title" created="20200419143537510" creator="soren" description="Copy the name of this tiddler to the clipboard" list-after="$:/core/ui/Buttons/info" modified="20210922125723154" modifier="soren" tags="$:/tags/ViewToolbar" title="$:/sib/Buttons/CopyTitleReference" type="text/vnd.tiddlywiki">
|
||||||
<pre>\whitespace trim
|
<pre>\whitespace trim
|
||||||
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{!!caption}} class=<<tv-config-toolbar-class>>>
|
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{$:/sib/Buttons/CopyTitleReference!!caption}} class=<<tv-config-toolbar-class>>>
|
||||||
<i class="far fa-copy" style="font-size:160%; position:relative; bottom:-4px; left:-1px;"/>
|
<$list filter="[<tv-config-toolbar-icons>match[yes]]">
|
||||||
|
<i class="far fa-copy" style="font-size:160%; position:relative; bottom:-4px; left:-1px;"/>
|
||||||
|
</$list>
|
||||||
|
<$list filter="[<tv-config-toolbar-text>match[yes]]">
|
||||||
|
<span class="tc-btn-text">
|
||||||
|
<$text text=" "/>
|
||||||
|
<$text text={{$:/sib/Buttons/CopyTitleReference!!caption}}/>
|
||||||
|
</span>
|
||||||
|
</$list>
|
||||||
</$button></pre>
|
</$button></pre>
|
||||||
</div>
|
</div>
|
||||||
<div caption="Excise private chunk" condition="[<targetTiddler>type[]] [<targetTiddler>type[text/vnd.tiddlywiki]] +[first[]]" created="20210522034413324" description="Create a new private chunk from the selection" icon="$:/core/images/locked-padlock" list-after="$:/core/ui/EditorToolbar/excise" modified="20210522034828757" shortcuts="((excise-private-chunk))" tags="$:/tags/EditorToolbar" title="$:/sib/Buttons/excise-private-chunk" type="text/vnd.tiddlywiki">
|
<div caption="Excise private chunk" condition="[<targetTiddler>type[]] [<targetTiddler>type[text/vnd.tiddlywiki]] +[first[]]" created="20210522034413324" description="Create a new private chunk from the selection" icon="$:/core/images/locked-padlock" list-after="$:/core/ui/EditorToolbar/excise" modified="20210522034828757" shortcuts="((excise-private-chunk))" tags="$:/tags/EditorToolbar" title="$:/sib/Buttons/excise-private-chunk" type="text/vnd.tiddlywiki">
|
||||||
@@ -16316,7 +16326,7 @@ THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, E
|
|||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
</div>
|
</div>
|
||||||
<div created="20210523150144006" creator="soren" description="Guided wizard that walks you through basic settings and the most important things to know about this edition." list="$:/sib/GettingStarted/Warning $:/sib/GettingStarted/Title $:/sib/GettingStarted/Copyright $:/sib/GettingStarted/ZettelkastenCardTypes $:/sib/GettingStarted/ReferenceExplorer $:/sib/GettingStarted/ThingsToDo $:/sib/GettingStarted/NextSteps" modified="20210920203903771" modifier="soren" tags="Meta Tool" title="$:/sib/GettingStarted" tooltype="configuration" type="text/vnd.tiddlywiki">
|
<div created="20210523150144006" creator="soren" description="Guided wizard that walks you through basic settings and the most important things to know about this edition." list="$:/sib/GettingStarted/Warning $:/sib/GettingStarted/Title $:/sib/GettingStarted/Copyright $:/sib/GettingStarted/ZettelkastenCardTypes $:/sib/GettingStarted/ReferenceExplorer $:/sib/GettingStarted/ThingsToDo $:/sib/GettingStarted/NextSteps" modified="20210922011910182" modifier="soren" tags="Meta Tool" title="$:/sib/GettingStarted" tooltype="configuration" type="text/vnd.tiddlywiki">
|
||||||
<pre>\define go-back() <$action-setfield $tiddler="$:/config/zettelkasten/GettingStartedWizardCurr" text={{{ [enlist{$:/sib/GettingStarted!!list}before{$:/config/zettelkasten/GettingStartedWizardCurr}] }}}/>
|
<pre>\define go-back() <$action-setfield $tiddler="$:/config/zettelkasten/GettingStartedWizardCurr" text={{{ [enlist{$:/sib/GettingStarted!!list}before{$:/config/zettelkasten/GettingStartedWizardCurr}] }}}/>
|
||||||
\define go-forward() <$action-setfield $tiddler="$:/config/zettelkasten/GettingStartedWizardCurr" text={{{ [enlist{$:/sib/GettingStarted!!list}after{$:/config/zettelkasten/GettingStartedWizardCurr}] }}}/>
|
\define go-forward() <$action-setfield $tiddler="$:/config/zettelkasten/GettingStartedWizardCurr" text={{{ [enlist{$:/sib/GettingStarted!!list}after{$:/config/zettelkasten/GettingStartedWizardCurr}] }}}/>
|
||||||
\define wizard-navbar()
|
\define wizard-navbar()
|
||||||
@@ -16364,7 +16374,7 @@ tzk is primarily designed for use with Node.js and has an associated helper comm
|
|||||||
* Highly configurable builds, allowing you to publish different versions of your wiki -- a common use case is publishing some of your content on the web and keeping some of it private.
|
* Highly configurable builds, allowing you to publish different versions of your wiki -- a common use case is publishing some of your content on the web and keeping some of it private.
|
||||||
* Space-efficient backups and version history with Git.
|
* Space-efficient backups and version history with Git.
|
||||||
|
|
||||||
Full instructions for installing and initializing the tzk command-line tool can be found on Read the Docs.
|
Full instructions for installing and initializing the tzk command-line tool can be [[found on Read the Docs|https://tzk.readthedocs.io/en/latest/]].
|
||||||
|
|
||||||
If you're familiar with command-line tools like tzk, you can get a quick start by making sure you have Git, NPM, and Python 3.6 or greater installed, then running:
|
If you're familiar with command-line tools like tzk, you can get a quick start by making sure you have Git, NPM, and Python 3.6 or greater installed, then running:
|
||||||
|
|
||||||
@@ -16438,13 +16448,15 @@ input.sib-copyright-input {
|
|||||||
}
|
}
|
||||||
</style></pre>
|
</style></pre>
|
||||||
</div>
|
</div>
|
||||||
<div caption="Next steps" created="20210828133924602" creator="soren" modified="20210828134435065" modifier="soren" tags="" title="$:/sib/GettingStarted/NextSteps" type="text/vnd.tiddlywiki">
|
<div caption="Next steps" created="20210828133924602" creator="soren" modified="20210922163144199" modifier="soren" tags="" title="$:/sib/GettingStarted/NextSteps" type="text/vnd.tiddlywiki">
|
||||||
<pre>Where do you go from here?
|
<pre>Where do you go from here?
|
||||||
|
|
||||||
I recommend starting by ''adding some notes''! Add a couple of tiddlers for the ideas rolling around in your head. Read a book, add a source tiddler for it, and link to it in some idea tiddlers.
|
I recommend starting by ''adding some notes''! Add a couple of tiddlers for the ideas rolling around in your head. Read a book, add a source tiddler for it, and link to it in some idea tiddlers.
|
||||||
|
|
||||||
Once you've gotten a few notes into the system, you will be in a good place to ''decide what elements of this edition you like and what things you'll want to change''. If you want to get into customizing the wiki and you don't have much experience with TiddlyWiki, check out [[Grok TiddlyWiki|https://groktiddlywiki.com/read]], a complete textbook and reference designed for learning how this stuff works from the ground up.
|
Once you've gotten a few notes into the system, you will be in a good place to ''decide what elements of this edition you like and what things you'll want to change''. If you want to get into customizing the wiki and you don't have much experience with TiddlyWiki, check out [[Grok TiddlyWiki|https://groktiddlywiki.com/read]], a complete textbook and reference designed for learning how this stuff works from the ground up.
|
||||||
|
|
||||||
|
At any time, you can watch [[an hour-long walkthrough video|https://www.youtube.com/watch?v=9X_T-DVie8o]] showing the most important features of tzk.
|
||||||
|
|
||||||
At any time, you can click the ''tools button {{$:/core/images/theme-button}}'' on the page toolbar (upper-right corner of the wiki, right under the title) to access a wide variety of tools, settings, and documentation related to the Zettelkasten edition.
|
At any time, you can click the ''tools button {{$:/core/images/theme-button}}'' on the page toolbar (upper-right corner of the wiki, right under the title) to access a wide variety of tools, settings, and documentation related to the Zettelkasten edition.
|
||||||
|
|
||||||
If you have questions, comments, or suggestions, please feel free to get in touch at `zettelkasten@sorenbjornstad.com`.</pre>
|
If you have questions, comments, or suggestions, please feel free to get in touch at `zettelkasten@sorenbjornstad.com`.</pre>
|
||||||
@@ -19535,6 +19547,11 @@ Remove the tag <$tiddler tiddler={{$:/temp/RenameTags/search}}><$transc
|
|||||||
</$list>
|
</$list>
|
||||||
</$reveal></pre>
|
</$reveal></pre>
|
||||||
</div>
|
</div>
|
||||||
|
<div caption="Tray" created="20210701023215046" creator="soren" description="Items we're currently working on but don't need to leave open. Drag and drop a link to a tiddler to add it." list="" modified="20210920155431768" modifier="soren" tags="Meta Tool" title="$:/sib/Tools/Tray" tooltype="aggregator" type="text/vnd.tiddlywiki">
|
||||||
|
<pre>Stuff I'm working on but don't need to keep open:
|
||||||
|
|
||||||
|
<<list-links-draggable "$:/sib/Tools/Tray" itemTemplate:"$:/sib/Tools/Tray/Template">></pre>
|
||||||
|
</div>
|
||||||
<div created="20210711192716590" creator="soren" modified="20210920140956221" modifier="soren" tags="" title="$:/sib/Tools/Tray/Template" type="text/vnd.tiddlywiki">
|
<div created="20210711192716590" creator="soren" modified="20210920140956221" modifier="soren" tags="" title="$:/sib/Tools/Tray/Template" type="text/vnd.tiddlywiki">
|
||||||
<pre>\define remove-tiddler()
|
<pre>\define remove-tiddler()
|
||||||
<$action-listops $tiddler="$:/sib/Tools/Tray" $field="list" $filter="[enlist{$:/sib/Tools/Tray!!list}] -[all[current]]"/>
|
<$action-listops $tiddler="$:/sib/Tools/Tray" $field="list" $filter="[enlist{$:/sib/Tools/Tray!!list}] -[all[current]]"/>
|
||||||
|
@@ -1,6 +1,8 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
|
. venv/bin/activate
|
||||||
|
rm -rf build/
|
||||||
rm -f dist/*
|
rm -f dist/*
|
||||||
mkdir -p dist
|
mkdir -p dist
|
||||||
python setup.py sdist bdist_wheel
|
python setup.py sdist bdist_wheel
|
||||||
|
2
setup.py
2
setup.py
@@ -9,7 +9,7 @@ with open("README.md", "r") as fh:
|
|||||||
|
|
||||||
setuptools.setup(
|
setuptools.setup(
|
||||||
name="tzk",
|
name="tzk",
|
||||||
version="0.1.0",
|
version="0.1.4",
|
||||||
author="Soren I. Bjornstad",
|
author="Soren I. Bjornstad",
|
||||||
author_email="zettelkasten@sorenbjornstad.com",
|
author_email="zettelkasten@sorenbjornstad.com",
|
||||||
description="Build tool for TiddlyWiki Zettelkasten",
|
description="Build tool for TiddlyWiki Zettelkasten",
|
||||||
|
@@ -402,7 +402,7 @@ def launch():
|
|||||||
parser = argparse.ArgumentParser(
|
parser = argparse.ArgumentParser(
|
||||||
description=f"TiddlyZettelKasten {TZK_VERSION} CLI\n"
|
description=f"TiddlyZettelKasten {TZK_VERSION} CLI\n"
|
||||||
f"Copyright (c) 2021 Soren Bjornstad.\n"
|
f"Copyright (c) 2021 Soren Bjornstad.\n"
|
||||||
f"MIT license; see https://github.com/sobjornstad/tzk/LICENSE for details.",
|
f"MIT license; see https://github.com/sobjornstad/tzk/blob/master/LICENSE for details.",
|
||||||
epilog="For full documentation, see https://tzk.readthedocs.io/en/latest/.",
|
epilog="For full documentation, see https://tzk.readthedocs.io/en/latest/.",
|
||||||
formatter_class=argparse.RawDescriptionHelpFormatter
|
formatter_class=argparse.RawDescriptionHelpFormatter
|
||||||
)
|
)
|
||||||
|
@@ -188,13 +188,13 @@ def check_for_kill_phrases(kill_phrase_file: str = None) -> None:
|
|||||||
:param kill_phrase_file: The path from the source wiki's root directory to the
|
:param kill_phrase_file: The path from the source wiki's root directory to the
|
||||||
config tiddler containing kill phrases. In the default
|
config tiddler containing kill phrases. In the default
|
||||||
Zettelkasten edition, this is
|
Zettelkasten edition, this is
|
||||||
tiddlers/_system/config/zettelkasten/Build/KillPhrases.tid;
|
"tiddlers/$__config_zettelkasten_Build_KillPhrases.tid";
|
||||||
if you change the way paths are determined, you can give
|
if you change the way paths are determined, you can give
|
||||||
a different path here.
|
a different path here.
|
||||||
"""
|
"""
|
||||||
assert 'public_wiki_folder' in build_state, "new_output_folder builder must run first"
|
assert 'public_wiki_folder' in build_state, "new_output_folder builder must run first"
|
||||||
if kill_phrase_file is None:
|
if kill_phrase_file is None:
|
||||||
kill_phrase_file = "tiddlers/_system/config/zettelkasten/Build/KillPhrases.tid"
|
kill_phrase_file = "tiddlers/$__config_zettelkasten_Build_KillPhrases.tid"
|
||||||
|
|
||||||
kill_phrases = set()
|
kill_phrases = set()
|
||||||
with open(kill_phrase_file) as f:
|
with open(kill_phrase_file) as f:
|
||||||
@@ -278,7 +278,8 @@ def compile_html_file(
|
|||||||
will be placed, relative to the private wiki's root directory.
|
will be placed, relative to the private wiki's root directory.
|
||||||
Default ``output/public_site``.
|
Default ``output/public_site``.
|
||||||
:param overwrite: If the ``output_folder`` already exists,
|
:param overwrite: If the ``output_folder`` already exists,
|
||||||
should we overwrite it? Default True.
|
should we overwrite any files in it with the same name?
|
||||||
|
Default True.
|
||||||
:param externalize_attachments: If True, update tiddlers that match
|
:param externalize_attachments: If True, update tiddlers that match
|
||||||
the ``attachment_filter`` parameter to point to
|
the ``attachment_filter`` parameter to point to
|
||||||
external versions of their content.
|
external versions of their content.
|
||||||
@@ -311,13 +312,10 @@ def compile_html_file(
|
|||||||
f"(To overwrite any files existing in the output folder, "
|
f"(To overwrite any files existing in the output folder, "
|
||||||
f"set overwrite = True for this builder.)")
|
f"set overwrite = True for this builder.)")
|
||||||
|
|
||||||
try:
|
|
||||||
shutil.rmtree(output_folder)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
shutil.copytree(
|
shutil.copytree(
|
||||||
Path(build_state['public_wiki_folder']) / "output",
|
Path(build_state['public_wiki_folder']) / "output",
|
||||||
Path(output_folder),
|
Path(output_folder),
|
||||||
|
dirs_exist_ok=True
|
||||||
)
|
)
|
||||||
info(f"Successfully copied built output to {os.path.abspath(output_folder)}.")
|
info(f"Successfully copied built output to {os.path.abspath(output_folder)}.")
|
||||||
|
|
||||||
|
@@ -1,15 +0,0 @@
|
|||||||
created: 20200427015719697
|
|
||||||
modified: 20200427020204931
|
|
||||||
tags:
|
|
||||||
title: $:/config/FileSystemPaths
|
|
||||||
type: text/vnd.tiddlywiki
|
|
||||||
|
|
||||||
[is[system]removeprefix[$:/]addprefix[_system/]]
|
|
||||||
[tag[Template]tag[Meta]tag[Tool]addprefix[_meta/]]
|
|
||||||
[tag[Image]tag[Attachment]addprefix[media/]]
|
|
||||||
[tag[Journal]addprefix[journal/]]
|
|
||||||
[tag[Source]addprefix[source/]]
|
|
||||||
[tag[Sink]addprefix[sink/]]
|
|
||||||
[tag[PAO]addprefix[pao/]]
|
|
||||||
[tag[Place]addprefix[place/]]
|
|
||||||
[tag[Publication]tag[Class]addprefix[metasource/]]
|
|
@@ -3,4 +3,4 @@ modified: 20201120173215063
|
|||||||
title: $:/config/ViewToolbarButtons/Visibility/$:/core/ui/Buttons/permalink
|
title: $:/config/ViewToolbarButtons/Visibility/$:/core/ui/Buttons/permalink
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
hide
|
show
|
@@ -1,6 +1,8 @@
|
|||||||
created: 20210525001044166
|
created: 20210525001044166
|
||||||
modified: 20210525000849030
|
creator: soren
|
||||||
|
modified: 20210922125743198
|
||||||
|
modifier: soren
|
||||||
title: $:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink
|
title: $:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
show
|
hide
|
@@ -0,0 +1,5 @@
|
|||||||
|
created: 20210731165327653
|
||||||
|
modified: 20210731173813193
|
||||||
|
title: $:/config/zettelkasten/Build/KillPhrases
|
||||||
|
type: text/vnd.tiddlywiki
|
||||||
|
|
@@ -1,9 +1,9 @@
|
|||||||
caption: Copy public Zettelkasten link
|
caption: copy public link
|
||||||
created: 20201120172611922
|
created: 20201120172611922
|
||||||
creator: soren
|
creator: soren
|
||||||
description: Copy a link to this tiddler in the public Zettelkasten
|
description: Copy a link to this tiddler in the public Zettelkasten
|
||||||
list-after: $:/core/ui/Buttons/info
|
list-after: $:/core/ui/Buttons/info
|
||||||
modified: 20210825162715432
|
modified: 20210922125543768
|
||||||
modifier: soren
|
modifier: soren
|
||||||
tags: $:/tags/ViewToolbar
|
tags: $:/tags/ViewToolbar
|
||||||
title: $:/sib/Buttons/CopyPublicZettelkastenLink
|
title: $:/sib/Buttons/CopyPublicZettelkastenLink
|
||||||
@@ -15,7 +15,15 @@ type: text/vnd.tiddlywiki
|
|||||||
\end
|
\end
|
||||||
|
|
||||||
<$set name="tidTitle" value={{!!title}}>
|
<$set name="tidTitle" value={{!!title}}>
|
||||||
<$button message="tm-copy-to-clipboard" param=<<copier>> tooltip={{!!caption}} class=<<tv-config-toolbar-class>>>
|
<$button message="tm-copy-to-clipboard" param=<<copier>> tooltip={{$:/sib/Buttons/CopyPublicZettelkastenLink!!caption}} class=<<tv-config-toolbar-class>>>
|
||||||
|
<$list filter="[<tv-config-toolbar-icons>match[yes]]">
|
||||||
{{$:/core/images/permalink-button}}
|
{{$:/core/images/permalink-button}}
|
||||||
|
</$list>
|
||||||
|
<$list filter="[<tv-config-toolbar-text>match[yes]]">
|
||||||
|
<span class="tc-btn-text">
|
||||||
|
<$text text=" "/>
|
||||||
|
<$text text={{$:/sib/Buttons/CopyPublicZettelkastenLink!!caption}}/>
|
||||||
|
</span>
|
||||||
|
</$list>
|
||||||
</$button>
|
</$button>
|
||||||
</$set>
|
</$set>
|
@@ -1,15 +1,23 @@
|
|||||||
caption: Copy tiddler title
|
caption: copy tiddler title
|
||||||
created: 20200419143537510
|
created: 20200419143537510
|
||||||
creator: soren
|
creator: soren
|
||||||
description: Copy the name of this tiddler to the clipboard
|
description: Copy the name of this tiddler to the clipboard
|
||||||
list-after: $:/core/ui/Buttons/info
|
list-after: $:/core/ui/Buttons/info
|
||||||
modified: 20210825162721583
|
modified: 20210922125723154
|
||||||
modifier: soren
|
modifier: soren
|
||||||
tags: $:/tags/ViewToolbar
|
tags: $:/tags/ViewToolbar
|
||||||
title: $:/sib/Buttons/CopyTitleReference
|
title: $:/sib/Buttons/CopyTitleReference
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
\whitespace trim
|
\whitespace trim
|
||||||
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{!!caption}} class=<<tv-config-toolbar-class>>>
|
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{$:/sib/Buttons/CopyTitleReference!!caption}} class=<<tv-config-toolbar-class>>>
|
||||||
<i class="far fa-copy" style="font-size:160%; position:relative; bottom:-4px; left:-1px;"/>
|
<$list filter="[<tv-config-toolbar-icons>match[yes]]">
|
||||||
|
<i class="far fa-copy" style="font-size:160%; position:relative; bottom:-4px; left:-1px;"/>
|
||||||
|
</$list>
|
||||||
|
<$list filter="[<tv-config-toolbar-text>match[yes]]">
|
||||||
|
<span class="tc-btn-text">
|
||||||
|
<$text text=" "/>
|
||||||
|
<$text text={{$:/sib/Buttons/CopyTitleReference!!caption}}/>
|
||||||
|
</span>
|
||||||
|
</$list>
|
||||||
</$button>
|
</$button>
|
@@ -2,7 +2,7 @@ created: 20210523150144006
|
|||||||
creator: soren
|
creator: soren
|
||||||
description: Guided wizard that walks you through basic settings and the most important things to know about this edition.
|
description: Guided wizard that walks you through basic settings and the most important things to know about this edition.
|
||||||
list: $:/sib/GettingStarted/Warning $:/sib/GettingStarted/Title $:/sib/GettingStarted/Copyright $:/sib/GettingStarted/ZettelkastenCardTypes $:/sib/GettingStarted/ReferenceExplorer $:/sib/GettingStarted/ThingsToDo $:/sib/GettingStarted/NextSteps
|
list: $:/sib/GettingStarted/Warning $:/sib/GettingStarted/Title $:/sib/GettingStarted/Copyright $:/sib/GettingStarted/ZettelkastenCardTypes $:/sib/GettingStarted/ReferenceExplorer $:/sib/GettingStarted/ThingsToDo $:/sib/GettingStarted/NextSteps
|
||||||
modified: 20210920203903771
|
modified: 20210922011910182
|
||||||
modifier: soren
|
modifier: soren
|
||||||
tags: Meta Tool
|
tags: Meta Tool
|
||||||
title: $:/sib/GettingStarted
|
title: $:/sib/GettingStarted
|
||||||
@@ -56,7 +56,7 @@ tzk is primarily designed for use with Node.js and has an associated helper comm
|
|||||||
* Highly configurable builds, allowing you to publish different versions of your wiki -- a common use case is publishing some of your content on the web and keeping some of it private.
|
* Highly configurable builds, allowing you to publish different versions of your wiki -- a common use case is publishing some of your content on the web and keeping some of it private.
|
||||||
* Space-efficient backups and version history with Git.
|
* Space-efficient backups and version history with Git.
|
||||||
|
|
||||||
Full instructions for installing and initializing the tzk command-line tool can be found on Read the Docs.
|
Full instructions for installing and initializing the tzk command-line tool can be [[found on Read the Docs|https://tzk.readthedocs.io/en/latest/]].
|
||||||
|
|
||||||
If you're familiar with command-line tools like tzk, you can get a quick start by making sure you have Git, NPM, and Python 3.6 or greater installed, then running:
|
If you're familiar with command-line tools like tzk, you can get a quick start by making sure you have Git, NPM, and Python 3.6 or greater installed, then running:
|
||||||
|
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
caption: Next steps
|
caption: Next steps
|
||||||
created: 20210828133924602
|
created: 20210828133924602
|
||||||
creator: soren
|
creator: soren
|
||||||
modified: 20210828134435065
|
modified: 20210922163144199
|
||||||
modifier: soren
|
modifier: soren
|
||||||
tags:
|
tags:
|
||||||
title: $:/sib/GettingStarted/NextSteps
|
title: $:/sib/GettingStarted/NextSteps
|
||||||
@@ -13,6 +13,8 @@ I recommend starting by ''adding some notes''! Add a couple of tiddlers for the
|
|||||||
|
|
||||||
Once you've gotten a few notes into the system, you will be in a good place to ''decide what elements of this edition you like and what things you'll want to change''. If you want to get into customizing the wiki and you don't have much experience with TiddlyWiki, check out [[Grok TiddlyWiki|https://groktiddlywiki.com/read]], a complete textbook and reference designed for learning how this stuff works from the ground up.
|
Once you've gotten a few notes into the system, you will be in a good place to ''decide what elements of this edition you like and what things you'll want to change''. If you want to get into customizing the wiki and you don't have much experience with TiddlyWiki, check out [[Grok TiddlyWiki|https://groktiddlywiki.com/read]], a complete textbook and reference designed for learning how this stuff works from the ground up.
|
||||||
|
|
||||||
|
At any time, you can watch [[an hour-long walkthrough video|https://www.youtube.com/watch?v=9X_T-DVie8o]] showing the most important features of tzk.
|
||||||
|
|
||||||
At any time, you can click the ''tools button {{$:/core/images/theme-button}}'' on the page toolbar (upper-right corner of the wiki, right under the title) to access a wide variety of tools, settings, and documentation related to the Zettelkasten edition.
|
At any time, you can click the ''tools button {{$:/core/images/theme-button}}'' on the page toolbar (upper-right corner of the wiki, right under the title) to access a wide variety of tools, settings, and documentation related to the Zettelkasten edition.
|
||||||
|
|
||||||
If you have questions, comments, or suggestions, please feel free to get in touch at `zettelkasten@sorenbjornstad.com`.
|
If you have questions, comments, or suggestions, please feel free to get in touch at `zettelkasten@sorenbjornstad.com`.
|
15
tzk/editions/tzk/tiddlers/$__sib_Tools_Tray.tid
Normal file
15
tzk/editions/tzk/tiddlers/$__sib_Tools_Tray.tid
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
caption: Tray
|
||||||
|
created: 20210701023215046
|
||||||
|
creator: soren
|
||||||
|
description: Items we're currently working on but don't need to leave open. Drag and drop a link to a tiddler to add it.
|
||||||
|
list:
|
||||||
|
modified: 20210920155431768
|
||||||
|
modifier: soren
|
||||||
|
tags: Meta Tool
|
||||||
|
title: $:/sib/Tools/Tray
|
||||||
|
tooltype: aggregator
|
||||||
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
|
Stuff I'm working on but don't need to keep open:
|
||||||
|
|
||||||
|
<<list-links-draggable "$:/sib/Tools/Tray" itemTemplate:"$:/sib/Tools/Tray/Template">>
|
10
tzk/tw.py
10
tzk/tw.py
@@ -122,11 +122,11 @@ def _init_tw(wiki_name: str) -> None:
|
|||||||
|
|
||||||
def _restore_plugins(wiki_name: str) -> None:
|
def _restore_plugins(wiki_name: str) -> None:
|
||||||
"""
|
"""
|
||||||
Add the plugins from the edition's tiddlywiki.info to the new wiki's
|
Add the two plugins required for client-server operation to the existing
|
||||||
tiddlywiki.info (for some reason, this is not done automatically). Also
|
ones in the edition, sort them in order, and replace the existing plugins
|
||||||
add the two plugins required for client-server operation.
|
array in the tiddlywiki.info.
|
||||||
"""
|
"""
|
||||||
print("tzk: Adding plugins to tiddlywiki.info...")
|
print("tzk: Configuring plugins in tiddlywiki.info...")
|
||||||
|
|
||||||
info_path = Path.cwd() / wiki_name / "tiddlywiki.info"
|
info_path = Path.cwd() / wiki_name / "tiddlywiki.info"
|
||||||
edition_path = Path(__file__).parent / "editions" / "tzk" / "tiddlywiki.info"
|
edition_path = Path(__file__).parent / "editions" / "tzk" / "tiddlywiki.info"
|
||||||
@@ -135,7 +135,7 @@ def _restore_plugins(wiki_name: str) -> None:
|
|||||||
info_data = json.load(f)
|
info_data = json.load(f)
|
||||||
with edition_path.open("r") as f:
|
with edition_path.open("r") as f:
|
||||||
edition_data = json.load(f)
|
edition_data = json.load(f)
|
||||||
|
|
||||||
plugins = {"tiddlywiki/filesystem", "tiddlywiki/tiddlyweb"}
|
plugins = {"tiddlywiki/filesystem", "tiddlywiki/tiddlyweb"}
|
||||||
plugins = plugins.union(edition_data['plugins'])
|
plugins = plugins.union(edition_data['plugins'])
|
||||||
info_data['plugins'] = sorted(plugins)
|
info_data['plugins'] = sorted(plugins)
|
||||||
|
@@ -10,7 +10,7 @@ import sys
|
|||||||
from typing import Any, Callable, Dict, NoReturn
|
from typing import Any, Callable, Dict, NoReturn
|
||||||
|
|
||||||
|
|
||||||
TZK_VERSION = "0.1.0"
|
TZK_VERSION = "0.1.4"
|
||||||
|
|
||||||
|
|
||||||
class BuildError(Exception):
|
class BuildError(Exception):
|
||||||
|
Reference in New Issue
Block a user