Changes between Version 5 and Version 6 of jogger

Show
Ignore:
Timestamp:
09/01/08 14:07:34 (2 years ago)
Author:
mgorny
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • jogger

    v5 v6  
    3131If everything works fine, jogger session should now copy status of joggerbot. 
    3232 
    33 == How to use == 
    34  
    35 === Comments === 
     33== Comments == 
    3634 
    3735When someone posts a comment on entry you're subscribing, jogger plugin intercepts message from bot: 
     
    5654 * stop subscribing to the thread with {{{/unsub}}} command, 
    5755 * or subscribe it again with {{{/sub}}}. 
     56 
     57== Entries == 
     58 
     59To post a new entry you can either: 
     60 * send it to bot like always, 
     61 * send it to {{{jogger:}}} UID in jogger session (which is gateway to bot), 
     62 * use file-based interface described below. 
     63 
     64If {{{ignore_outgoing_entries}}} session variable is set, jogger plugin will not display sent entries as messages. Else they'll appear as messages sent to {{{jogger:}}}. 
     65 
     66=== File-based interface === 
     67 
     68First you need to write new entry and save it as a standard file. Here we'll assume that you named it {{{~/entry.html}}} (using .html extension triggers syntax highliting in many editors). 
     69 
     70Then (in jogger session) you call: 
     71{{{ 
     72/prepare ~/entry.html 
     73}}} 
     74 
     75Now if file can be read successfully, jogger plugin can output some warnings and then: 
     76{{{ 
     7714:03:39 ::: File ~/entry.html is ready for submission. 
     78}}} 
     79 
     80If you want to modify the file and recheck it, just run {{{/prepare}}} again. It does memorize last used file, so you don't have to enter it again. 
     81 
     82When your entry is ready for submission, use: 
     83{{{ 
     84/publish 
     85}}} 
     86 
     87If file was modified after last {{{/prepare}}}, {{{/publish}}} will notify you about checksum change and refuse to publish it. You can then call {{{/prepare}}} to check the entry, or use {{{/publish}}} again to force submission.