Skip to content

Commit

Permalink
Update documentation - fixes #11
Browse files Browse the repository at this point in the history
Update checkbox documentation
Update horizontal line documentation
Update hacking notebook with up-to-date links and info
Fix minory typo in docs
  • Loading branch information
nasedil authored and jaap-karssenberg committed Jun 29, 2017
1 parent 2d0ead5 commit c1bb372
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 13 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.txt
Expand Up @@ -43,7 +43,7 @@ Earlier version numbers for zim correspond to the Perl branch.
* Improved performance tag filtering in side pane
* Detect pages have changed on disk, even when page present in cache
* Bug fix for drag-n-drop of text within the editor
* New checkbox type available for "moved task" for joural workflow
* New checkbox type available for "moved task" for journal workflow
* Context menu defined for checkboxes
* Horizontal lines "<HR>" added to wiki syntax -- Pavel_M
* Pathbar buttons can now also be used to insert page links by drag-n-drop
Expand Down
5 changes: 4 additions & 1 deletion HACKING/HACKING.txt
Expand Up @@ -13,8 +13,11 @@ When you are working with the development code check the folder "./tools/" for s

In addition we use the following resources to communicate on zim development:

Code repository:
https://github.com/jaap-karssenberg/zim-desktop-wiki

Bug tracker:
https://bugs.launchpad.net/zim
https://github.com/jaap-karssenberg/zim-desktop-wiki/issues (and many requests are on the old page https://bugs.launchpad.net/zim)
Also for feature requests

Development wiki:
Expand Down
19 changes: 10 additions & 9 deletions HACKING/Working_with_Bazaar.txt
Expand Up @@ -4,21 +4,22 @@ Creation-Date: 2014-07-31T21:05:49+02:00

====== Working with Bazaar ======

The zim code is kept under version control using the bazaar version control system. See the website for documentation on using this system: http://bazaar.canonical.com/en/
The zim code is kept under version control using the git version control system. See the website for documentation on using this system: https://git-scm.com/

The quick course, to get a copy of the zim code:
The quick course, to get a copy of the zim code from a fork username/zim-desktop-wiki on github:

bzr branch lp:zim
git clone git@github.com:username/zim-desktop-wiki.git

To check in some changes (don't forget to give some meaningful changelog)
Then you can create a branch:

bzr add
bzr commit
git checkout -b branch-name

To check in some changes (don't forget to give some meaningful changelog):

To create a patch that can be mailed:
git add
git commit

bzr send -o some-description.patch
After that you can make a pull request on github or create a patch that can be mailed:

Alternatively you can publish your branch directly on the launchpad website and file a merge proposal.
git format-patch HEAD~..HEAD

11 changes: 10 additions & 1 deletion data/manual/Help/Auto_Formatting.txt
Expand Up @@ -37,4 +37,13 @@ This feature can be turned off in the [[Preferences]].
Also when you type a internet url like http://perl.org it will automatically be identified as a link.

===== Bullets and Checkboxes =====
Another example of auto-formatting is that "* " at the beginning of a line gets converted to a bullet automatically. Typing either "[] ", "[*] ", "[x] " or "() ", "(*) ", "(x) " will give your different kinds of [[Check Boxes]].
Another example of auto-formatting is that "* " at the beginning of a line gets converted to a bullet automatically. Typing either "[] ", "[*] ", "[x] ", "[>] " or "() ", "(*) ", "(x) ", "(>) " will give your different kinds of [[Check Boxes]].

===== Horizontal line =====
Typing five dashes:

''-----''

gives you a horizontal line:

--------------------
3 changes: 2 additions & 1 deletion data/manual/Help/Check_Boxes.txt
Expand Up @@ -11,8 +11,9 @@ Zim supports lists with checkboxes instead of bullets. These look like:
[*] item 2a
[x] item 2b
[*] item3
[>] item4

As you can see in this example checkboxes can have 3 states: [ ] open, [*] checked as 'OK' and [x] checked as 'NOK'. States can be toggle by clicking the checkbox with either the left mouse button or using the keyboard with ''<F12>'' and ''<shift><F12>'' respectively.
As you can see in this example checkboxes can have 4 states: [ ] open, [*] checked as completed, [x] checked as not completed, and [>] checked as moved. States can be toggle by clicking the checkbox with either the left mouse button or using the keyboard with ''<F12>'' and ''<shift><F12>'' respectively.

To start a checkbox list type on an empty line '''[]<space>''' or '''()<space>''', this will automatically insert an open checkbox. Similarly you can type checked checkboxes using '''[*]''' or '''(*)''' and '''[x]''' or '''(x)''' respectively, followed by '''<space>''' or '''<tab>'''. Lines that start with a checkbox behave like bullet list items, so you can indent by typing ''<tab>'' after the checkbox and when you press ''<enter>'' the new line will start with an empty checkbox automatically.

Expand Down

0 comments on commit c1bb372

Please sign in to comment.