Skip to content

Commit

Permalink
1000: Minor refactor and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesroelli committed Mar 18, 2017
1 parent 346140f commit ed62187
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 80 deletions.
17 changes: 9 additions & 8 deletions README
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
org-board
=========

Last updated: 3:19 pm February 27, 2017
Last updated: 3:31 pm March 18, 2017

* Motivation

Expand Down Expand Up @@ -32,19 +32,20 @@ Last updated: 3:19 pm February 27, 2017
* User commands

`org-board-archive' archives the current entry, creating a unique
ID and directory via org-attach if necessary.
ID and directory via `org-attach' if necessary.

`org-board-archive-dry-run' shows the `wget' invocation that will
run for this entry.
run for this entry in the echo area.

`org-board-new' prompts for a URL to add to the current entry's
properties, then archives it immediately.
properties, then archives the entry immediately.

`org-board-delete-all' deletes all the archives for this entry by
deleting the org-attach directory.
deleting the `org-attach' directory.

`org-board-open' Opens the bookmark at point in a browser.
Default to the built-in browser, and with prefix, the OS browser.
`org-board-open' opens the bookmark at point in a browser.
Default to the built-in browser, `eww', and with prefix, the
native operating system browser.

`org-board-diff' uses `zdiff' (if available) or `ediff' to
recursively diff two archives of the same entry.
Expand Down Expand Up @@ -278,7 +279,7 @@ Last updated: 3:19 pm February 27, 2017

(add-hook 'org-capture-before-finalize-hook 'do-org-board-dl-hook)

Acknowledgements
* Acknowledgements

Thanks to Alan Schmitt for the code to combine `org-board' and
`org-capture', and for the example function used in the
Expand Down
14 changes: 7 additions & 7 deletions TODO.org
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
* TODO Add more error checking
** Check for no URL property set
** Check that we have connectivity before starting `wget'
* TODO Add a sample capture template
* DONE Add a sample capture template
* TODO Exporting options for an archive
Allow exporting an archived page or set of pages to PDF?
* TODO Zip archive to file
Expand All @@ -171,11 +171,14 @@
Eww, will take the URL of the current page and archive that one, or
if not in Eww, take a URL from the clipboard.

* TODO Add wget output logging in the archival root
* DONE Add wget output logging in the archival root
* DONE Autodetect `wget' from PATH
* DONE Add dry run option

* TODO Add asterisks in doc for easy transfer to README
* DONE Add asterisks in doc for easy transfer to README
* TODO Add support for remote files
With remote archival. `process-file' is apparently for this.
* TODO Add buffer marker pointing to archive entry
* Style
** TODO Code repetition in org-board-archive-dry-run
All the let bindings are are copied from the worker functions.
Expand All @@ -190,10 +193,7 @@
** TODO Export
Exporting a bookmarks file (or an org-board entry) isn't
spectacular: the properties are not shown, for example, so there's
no internal link to the file archived. The title of each exported
entry should link to the "obvious" choice of what was archived
(using the Levenshtein algorithm above, see the [[file:~/Datacar/Computing/org/bookmarks.org::*Levenshtein%20distance%20in%20Emacs][algorithm]] by Aaron
S. Hawley).
no internal link to the file archived.
* Bugs
** FIXED Bug with %-encoded URLs
[2016-09-22 Thu 15:11] Calling `message' (like in
Expand Down
Loading

0 comments on commit ed62187

Please sign in to comment.