Home

USAGE

sfwiki -c|-d|-h [SUBJECT]|-p|-r|-s|-t PAGE TITLE|-v

This SF Wiki Helper script enables off-line editing and git version control of
markdown files for the standard SourceForge wiki tool. In this way you can
prepare changes in documentation while working on a release and publish them at
the moment your release becomes available to the public.

You need to run sfwiki from a git repository and from the directory where you
keep or are going to keep the markdown files for your project's wiki.

When prompted for project and wiki name, enter them exactly as they appear in
the URL to your project's wiki.

sfwiki uses the 'master' branch as a reference to the current on-line contents
of the wiki. If you use another default branch, e.g. 'trunk', then you can
change it with 'sfwiki -c'.

For publishing pages you need to enter a bearer token. See the FAQ (sfwiki -h
faq) for how to obtain one and other questions about bearer tokens.

Use one option at a time:
    -c  Configures default branch, 'detect renamed pages' mode  and the
        similarity threshold for detecting renamed pages.
    -d  Downloads markdown, labels and attachments for all pages of project wiki
        tool. Only goes ahead if current directory is empty or if there are no
        differences between current directory and corresponding directory in 
        master.
    -h  Shows this help text or help on optional SUBJECT:
        - requirements
        - configuration
        - workflow
        - offline (off-line editing of wiki pages)
        - rename (renaming pages)
        - faq
        - history and
        - all (show all subjects).
    -p  Publish changed markdown and labels to project wiki tool. List changes
        that you need to do manually after publishing.
    -r  Review renamed pages and manual actions prior to and after publishing.
    -s  See a preview of what is going to be published. Same output as -p
        without actually publishing.
    -t  Test publish page with given PAGE TITLE. Publishes markdown without
        labels. After reviewing the published page you need to manually revert
        to the previous version or delete the page if it did not exist before.
    -v  Show sfwiki version.

[REQUIREMENTS]
[CONFIGURATION]
[WORK FLOW]
[OFF-LINE EDITING]
[RENAME PAGES]
[FAQ]
[HISTORY]