tzk/tzk/default_config.py

# Default tzk config
# <<GENERATION_DETAILS>>

# This config file is live, unrestricted Python.
# You can add your own builders or logic here if necessary.
# tzk's package directory is on the PYTHONPATH when this module is imported,
# so if you want to import a function from, e.g., tzk.util,
# just say 'from tzk.util import whatever'.

#------------------------------------------------------------------------------#

# Imports. Don't remove this or you won't be able to configure builders.
from tzk import builders

# Name of the subfolder containing your wiki data and its tiddlywiki.info file.
wiki_folder = "wiki"


### COMMITTING ####
# Default commit message to use with 'tzk commit'.
# You can always use 'tzk commit -m' to use a different message on the fly.
commit_message = "checkpoint"

# Git remote to push changes to when you run 'tzk commit'.
# If you never want to push changes, set this to the empty string ("").
commit_remote = ""
#commit_remote = "origin"

# Uncomment if you want to abort 'tzk commit' if you're not on a specific branch.
#commit_require_branch = "master"


### LISTENING ###
# Port to listen on. If you specify 8080 for example, you'll edit your wiki by going to
# http://localhost:8080 in your browser.
listen_port = 8080

# Host to listen on. If you specify "0.0.0.0" it will listen to all network interfaces.
# This is useful for allowing the wiki to be exposed to the network through a container.
listen_host = "127.0.0.1"

# Uncomment if you want to require HTTP basic authentication when serving your wiki.
# **WARNING**: this is NOT secure for use over the open Internet or all but the
# simplest local networks, as the password is sent in the clear. For good
# security, you need to add a reverse proxy on top that secures the connection via SSL.
#listen_username = "my_user"
#listen_password = "my_password"


### BUILD ###
# Filter for tiddlers that should be included in a public export of the wiki.
_public_export_filt = r"""
    [is[system]]
    [tag[Public]]
    -[[$:/plugins/tiddlywiki/tiddlyweb]]
    -[[$:/plugins/tiddlywiki/filesystem]]
    -[prefix[$:/temp]]
    -[prefix[$:/state]]
    -[prefix[$:/sib/StorySaver/saved]]
    -[prefix[$:/checkify/]]
    -[[$:/config/zettelkasten/Build/KillPhrases]]
"""

# Each "product" is a different deliverable or target. A product can be built
# by running 'tzk build PRODUCT'. You can include any number of products,
# each of which can use any number of "builders", micro-build steps that
# perform a small part of the build. The configured builders are run in sequence.
#
# See the "Builders" section of the tzk documentation
# for details on the available builders and their parameters.
#
# If you want to do something that's not covered by the builders shipped with tzk,
# you can write your own, or you can run arbitrary shell commands
# using a 'builders.shell("my shell command here"),' builder.
products = {
    # The default configuration contains a single product for building a public wiki;
    # use 'tzk build public' to build it. You can add as many products as you want.
    'public': [
        # Create a temporary folder to hold the public wiki as we work on it.
        builders.new_output_folder(),
        # Pull the tiddlers matching the filter we defined above from our private wiki
        # and put them in a new public wiki in the temporary folder.
        builders.export_public_tiddlers(export_filter=_public_export_filt),
        # Replace the names of people who don't have public tiddlers with their initials.
        builders.replace_private_people(),
        # Change the 'text' field of these tiddlers to new values.
        builders.set_tiddler_values(text={
            '$__config_sib_CurrentEditionPublicity.tid': 'public',
            '$__config_sib_IsPublicEdition.tid': 'false',
            '$__config_DefaultSidebarTab.tid': '$:/sib/SideBar/Explore',
            '$__DefaultTiddlers.tid': 'PublicHomepage',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_close-all.tid': 'show',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_control-panel.tid': 'hide',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_home.tid': 'show',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_more-page-actions.tid': 'show',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_new-tiddler.tid': 'hide',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_permaview.tid': 'show',
            '$__config_PageControlButtons_Visibility_$__core_ui_Buttons_tag-manager.tid': 'hide',
            '$__config_PageControlButtons_Visibility_$__sib_Buttons_NewSource.tid': 'hide',
            '$__config_PageControlButtons_Visibility_$__sib_Buttons_ReadingInbox.tid': 'hide',
            '$__config_ViewToolbarButtons_Visibility_$__core_ui_Buttons_close-others.tid': 'show',
            '$__config_ViewToolbarButtons_Visibility_$__core_ui_Buttons_edit.tid': 'hide',
            '$__config_ViewToolbarButtons_Visibility_$__core_ui_Buttons_info.tid': 'hide',
            '$__config_ViewToolbarButtons_Visibility_$__core_ui_Buttons_permalink.tid': 'show',
            '$__config_ViewToolbarButtons_Visibility_$__sib_Buttons_CopyPublicZettelkastenLink.tid': 'hide',
            '$__config_ViewToolbarButtons_Visibility_DoCopyTitleReference.tid': 'hide',
        }),
        # Fail the build if kill phrases (things we definitely don't want to make
        # public, configured within the wiki) are found in the build.
        builders.check_for_kill_phrases(),
        # Save images to separate files.
        builders.save_attachments_externally(),
        # Create a single HTML file from the public wiki, externalizing the images
        # as we do, and copy it and the extimages folder to the output/public_wiki
        # folder inside our private wiki.
        builders.compile_html_file(externalize_attachments=True),
    ],
    # If you want a second product, add it like this:
    #'secondproduct': [
    #    builders.new_output_folder(),
    #    ... and so on ...
    #],
}