Compare commits
11 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
f8edb70065 | ||
![]() |
218705bdc9 | ||
![]() |
48a8789c4d | ||
![]() |
48ab7f9514 | ||
![]() |
f2d9a2abe6 | ||
![]() |
cb55a967d0 | ||
![]() |
52c0daedbb | ||
![]() |
09b856488b | ||
![]() |
9218a83d41 | ||
![]() |
a896244367 | ||
![]() |
ec83de9978 |
13
README.md
13
README.md
@@ -19,7 +19,7 @@ Some basic knowledge of [TiddlyWiki](https://tiddlywiki.com)
|
||||
|
||||
|
||||
Documentation / Installation
|
||||
============================
|
||||
----------------------------
|
||||
|
||||
Find a live version of the edition on the web with further instructions
|
||||
at https://sobjornstad.github.io/tzk/.
|
||||
@@ -28,3 +28,14 @@ You can find the documentation for the CLI
|
||||
versioning with Git,
|
||||
and creating public and other derivative versions of the wiki)
|
||||
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).
|
||||
|
@@ -18,9 +18,9 @@ copyright = '2021 Soren Bjornstad'
|
||||
author = 'Soren Bjornstad'
|
||||
|
||||
# The short X.Y version
|
||||
version = "0.1.1"
|
||||
version = "0.1.4"
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = "0.1.1"
|
||||
release = "0.1.4"
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
@@ -822,6 +822,8 @@ Error message and password prompt
|
||||
|
||||
<li>$:/sib/Tools/TagReplace</li>
|
||||
|
||||
<li>$:/sib/Tools/Tray</li>
|
||||
|
||||
<li>$:/sib/Tools/Tray/Template</li>
|
||||
|
||||
<li>$:/SiteSubtitle</li>
|
||||
@@ -1206,13 +1208,13 @@ github: https://github.com/sobjornstad/zettelkasten-sib</pre>
|
||||
<pre>hide</pre>
|
||||
</div>
|
||||
<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 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>
|
||||
</div>
|
||||
<div created="20210525001044166" modified="20210525000849030" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink" type="text/vnd.tiddlywiki">
|
||||
<pre>show</pre>
|
||||
<div created="20210525001044166" creator="soren" modified="20210922125743198" modifier="soren" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink" type="text/vnd.tiddlywiki">
|
||||
<pre>hide</pre>
|
||||
</div>
|
||||
<div created="20210525001045047" modified="20210525000850061" title="$:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyTitleReference" type="text/vnd.tiddlywiki">
|
||||
<pre>show</pre>
|
||||
@@ -16043,22 +16045,38 @@ Info: CoreVersion parameter is needed for TiddlyWiki only!
|
||||
}
|
||||
}</pre>
|
||||
</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
|
||||
\define copier()
|
||||
https://zettelkasten.sorenbjornstad.com/#$(tidTitle)$
|
||||
\end
|
||||
|
||||
<$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}}
|
||||
</$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>
|
||||
</$set></pre>
|
||||
</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
|
||||
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{!!caption}} class=<<tv-config-toolbar-class>>>
|
||||
<i class="far fa-copy" style="font-size:160%; position:relative; bottom:-4px; left:-1px;"/>
|
||||
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{$:/sib/Buttons/CopyTitleReference!!caption}} class=<<tv-config-toolbar-class>>>
|
||||
<$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>
|
||||
</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">
|
||||
@@ -16430,13 +16448,15 @@ input.sib-copyright-input {
|
||||
}
|
||||
</style></pre>
|
||||
</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?
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
If you have questions, comments, or suggestions, please feel free to get in touch at `zettelkasten@sorenbjornstad.com`.</pre>
|
||||
@@ -19527,6 +19547,11 @@ Remove the tag <$tiddler tiddler={{$:/temp/RenameTags/search}}><$transc
|
||||
</$list>
|
||||
</$reveal></pre>
|
||||
</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">
|
||||
<pre>\define remove-tiddler()
|
||||
<$action-listops $tiddler="$:/sib/Tools/Tray" $field="list" $filter="[enlist{$:/sib/Tools/Tray!!list}] -[all[current]]"/>
|
||||
|
@@ -1,6 +1,8 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
. venv/bin/activate
|
||||
rm -rf build/
|
||||
rm -f dist/*
|
||||
mkdir -p dist
|
||||
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(
|
||||
name="tzk",
|
||||
version="0.1.1",
|
||||
version="0.1.4",
|
||||
author="Soren I. Bjornstad",
|
||||
author_email="zettelkasten@sorenbjornstad.com",
|
||||
description="Build tool for TiddlyWiki Zettelkasten",
|
||||
|
@@ -278,7 +278,8 @@ def compile_html_file(
|
||||
will be placed, relative to the private wiki's root directory.
|
||||
Default ``output/public_site``.
|
||||
: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
|
||||
the ``attachment_filter`` parameter to point to
|
||||
external versions of their content.
|
||||
@@ -311,13 +312,10 @@ def compile_html_file(
|
||||
f"(To overwrite any files existing in the output folder, "
|
||||
f"set overwrite = True for this builder.)")
|
||||
|
||||
try:
|
||||
shutil.rmtree(output_folder)
|
||||
except FileNotFoundError:
|
||||
pass
|
||||
shutil.copytree(
|
||||
Path(build_state['public_wiki_folder']) / "output",
|
||||
Path(output_folder),
|
||||
dirs_exist_ok=True
|
||||
)
|
||||
info(f"Successfully copied built output to {os.path.abspath(output_folder)}.")
|
||||
|
||||
|
@@ -3,4 +3,4 @@ modified: 20201120173215063
|
||||
title: $:/config/ViewToolbarButtons/Visibility/$:/core/ui/Buttons/permalink
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
hide
|
||||
show
|
@@ -1,6 +1,8 @@
|
||||
created: 20210525001044166
|
||||
modified: 20210525000849030
|
||||
creator: soren
|
||||
modified: 20210922125743198
|
||||
modifier: soren
|
||||
title: $:/config/ViewToolbarButtons/Visibility/$:/sib/Buttons/CopyPublicZettelkastenLink
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
show
|
||||
hide
|
@@ -1,9 +1,9 @@
|
||||
caption: Copy public Zettelkasten link
|
||||
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: 20210825162715432
|
||||
modified: 20210922125543768
|
||||
modifier: soren
|
||||
tags: $:/tags/ViewToolbar
|
||||
title: $:/sib/Buttons/CopyPublicZettelkastenLink
|
||||
@@ -15,7 +15,15 @@ type: text/vnd.tiddlywiki
|
||||
\end
|
||||
|
||||
<$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}}
|
||||
</$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>
|
||||
</$set>
|
@@ -1,15 +1,23 @@
|
||||
caption: Copy tiddler title
|
||||
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
|
||||
modified: 20210922125723154
|
||||
modifier: soren
|
||||
tags: $:/tags/ViewToolbar
|
||||
title: $:/sib/Buttons/CopyTitleReference
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
\whitespace trim
|
||||
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{!!caption}} class=<<tv-config-toolbar-class>>>
|
||||
<i class="far fa-copy" style="font-size:160%; position:relative; bottom:-4px; left:-1px;"/>
|
||||
<$button message="tm-copy-to-clipboard" param={{!!title}} tooltip={{$:/sib/Buttons/CopyTitleReference!!caption}} class=<<tv-config-toolbar-class>>>
|
||||
<$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>
|
@@ -1,7 +1,7 @@
|
||||
caption: Next steps
|
||||
created: 20210828133924602
|
||||
creator: soren
|
||||
modified: 20210828134435065
|
||||
modified: 20210922163144199
|
||||
modifier: soren
|
||||
tags:
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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,7 +10,7 @@ import sys
|
||||
from typing import Any, Callable, Dict, NoReturn
|
||||
|
||||
|
||||
TZK_VERSION = "0.1.1"
|
||||
TZK_VERSION = "0.1.4"
|
||||
|
||||
|
||||
class BuildError(Exception):
|
||||
|
Reference in New Issue
Block a user