Wazup 1.3

;===============================================
; Web-page monitoring (Wazup v1.3)
;-----------------------------------------------

; This configuration isn't practically usefull for people
; who don't know Russian, but it was alone page available
; locally on my machine :)

*Wazup LSAtRu

; NewsItem describes a pattern for extracting information about
; one news item. This little trick would help us to avoid
; silly copying

NewsItem "news_top{%quote}>{%}</td>{*}right{%quote}>{%}</div></td>{*}news_post{%quote}>{%}<div align={%quote}right"

LSAtRuURL http://www.litestep.bip.ru/
LSAtRuUpdateInterval 10
LSAtRuInputString "$NewsItem${*}$NewsItem${*}$NewsItem${*}$NewsItem${*}$NewsItem$"

LSAtRuOutputString "LiteStep@Russia News\n\n{%1}\n{%2}\n{%3}\n\n{%4}\n{%5}\n{%6}\n\n{%7}\n{%8}\n{%9}\n\n{%10}\n{%11}\n{%12}\n\n{%13}\n{%14}\n{%15}"

LSAtRuEnabled true

LSAtRuOnChecked !Execute [!WazupSetUpdateInterval LSAtRu 900][!LabelShow NewsLabel]
LSAtRuOnFailure !Execute [!WazupSetUpdateInterval LSAtRu 10]

LSAtRuOnUpdated !alert "Someting new!"

LSAtRuLocalFile "$MiscDir$lsnews.html"
LSAtRuDisplayOn NewsLabel

;======================
*Label NewsLabel
;----------------------
NewsLabelX 100
NewsLabelY 100
NewsLabelWidth 300
NewsLabelHeight 600
NewsLabelText "Here would be the dragons"
NewsLabelImage lsnews.png
NewsLabelImageMode stretch
NewsLabelImageTopEdge 3
NewsLabelImageBottomEdge 3
NewsLabelLeftBorder 5
NewsLabelRightBorder 5
NewsLabelTopBorder 10
NewsLabelBottomBorder 5
NewsLabelAutoLineBreak true
NewsLabelAlign left
NewsLabelVertAlign top
NewsLabelStartHidden
NewsLabelScroll vertical-up

(query name)URL [web-page]
Web page URL. You cannot use local files as URL!
Default: http://www.shellfront.org/

(query name)LocalFile [file]
If set, this file would be used for tracking changes of the web page. If you skipped this option then temporary file would be used and OnUpdated action would be disabled
Default: empty string, tracking disabled

(query name)Enabled [false/true]
If enabled, news would be automatically updated. Else you need to use !WazupCheck bang manually
Default: true

(query name)UpdateInterval [number]
Time interval between checking (in seconds!).
Default : 600 (10 minutes)

(query name)InputString [pattern]
This string defines a page pattern which would be used to determine placement of the target information on the page.
The module compares the pattern with a downloaded page and extracts usefull substrings from there.
Count of the extracted text strings started from 1.
For example, if target page looks like this:

  <html>
  <body>
    21.04.2004<br>
    Seg@<br>
    Wazzzzzup!
  </body>
</html>

and the pattern is the following:

wazup.dll would extract 3 substrings from the page:
  1 - 21.04.2004
  2 - Seg@
  3 - Wazzzzzup!
More detailed information about how to write pattern available here
Default: {%}

(query name)OutputString [pattern]
This string defines a form of the output, e.g. transformed text. It is just a text where strings to be extracted are replaced with {%N} (N is the number of an extracted string).
For example, if parsing of the web-page give us the following set of strings:
  1 - 21.04.2004
  2 - Seg@
  3 - Wazzzzzup!
then the following pattern:

Post date: {%1}\nNews Maker: {%2}\n{%3}

let us to show in Label "right" formatted text:

Post date: 21.04.2004
News Maker: Seg@
Wazzzzzup!

Default: {%1}

(query name)NewLine [string]
<br> and <p> HTML tags replaced with this string when text displayed on label. Use this setting if you want to use single line label with scrolling.
Default: "\n"

(query name)FileNewLine [string]
Newline character from the downloaded web page file would be replaced with this string when writing OutputString to the OutputFile. If you don't need such replacement then you should use "\n"
For example, if extracted strings contains multiple lines:
  1 - 21.04.2004
  2 - Seg@
  3 - Wazzzzzup!
      The second string.
      Le fin.
and you need to save them into the out.rc as $eVars$: param1, param2 and param3. You may use the following settings:

[Prefix]OutputFile "$ConfigDir$news.rc"
[Prefix]FileNewLine " "
[Prefix]OutputString "param1 {%quote}{%1}{%quote}\nparam2 {%quote}{%2}{%quote}\nparam3 {%quote}{%3}{%quote}"

And news.rc would contain the following text:

param1 "21.04.2004"
param2 "Seg@"
param3 "Wazzzzzup! The second string. Le fin."

Default: "\n"

(query name)DisplayNewLineAs [string]
New line character from the downloaded web page file would be replaced with this string when displaying text using labels.
Default: "\n"

(query name)OnChecked [action]
Action performed after successfull downloading and parsing of the web page.
Default: !none

(query name)OnFailure [action]
Action performed if the downloading or the page parsing failed.
Default: !none

(query name)OnUpdated [action]
Action performed if the page changed after last checking. Required LocalFile to be set to work.
Default: !none

(query name)DisplayOn [label name]
If set and not empty then this label would be used to display output string.
Default: empty

(query name)OutputFile [file path]
If set and not empty then output string would be written to this file after each successfull web-page checking
You may use this option, for instance, if you want to display "true HTML" with Oborzevatel module. Wazup.dll doesn't remove HTML tags before writing a file, although for Label output does.
Default: empty

(query name)ShowProgress [false/true]
To show special message on primary label during download process or not.
Default: true

(query name)ProgressInfo [string]
Text displayed on the label during web page downloading. Here is a list of available escape-sequences:
{downloaded} - number of bytes read...
{size} - file length...
{%} - 100*read/size...
Default: Loading... {%}% complete

First parameter of each !bang is query name.
For example, to read a page described by MySiteNews query you need to type the following thing:

!WazupCheck MySiteNews

Full list of available !bangs:

!WazupCheck (query name)
Check web page just now.

!WazupEnable (query name)
Enable autoupdating of the page.

!WazupDisable (query name)
Disable autoupdating.

!WazupToggle (query name)
Toggle autoupdating state.

!WazupSetURL (query name) [URL]
Change source web-page URL.

!WazupSetInputString (query name) [pattern]
Change web-page pattern.

!WazupSetOutputString (query name) [pattern]
Change output format.

!WazupSetUpdateInterval (query name) [time in seconds]
Change time interval between checking.

!WazupSetLabelText (query name) [label name] [pattern]
Change label text using the pattern. Use this !bang to define secondary label displays since label text is prepared in the same way as for primary label defined by DisplayOn setting.

!WazupParseCommand (query name) !bang
Replace escape-sequences "{%N}" in the !bang parameters to the extracted strings, then execute this !bang. For instance,

!WazupParseCommand LSAtRu !Alert "{%1}"

NOTE: if extracted strings contained doublequotes (") they would be replaced with the singlequotes (').

Pattern is a regular string where some pieces of text replaced with escape-sequences. Here is a list of escape-sequences you may use in Wazup input-string pattern

{*}
Any text. Use this to skip something long but doesn't matter for you

{%}
Extracted substring. This sequence means that here is usefull information which must to be memorized for future use in output.

{%,N}
Extracted substring consists of N symbols

{%quote}
Doublequotes

Extracted strings are numerated from 1 using the order of extraction.

Just some important notes:

If InputString contain spaces it should be framed with doublequotes.

If InputString contain doublequotes, you need to replace them with escape-sequence: {%quote}

If you want to extract news body, you should do this like in the sample config-file: use $eVar$ to define separate news item. It would save your time and make RC more readable :)

Don't forget that maximal length of the RC-file line is 4096 characters (with expanded enviroment variables)!!!

That's why sometimes you may use {*} instead of {%quote} - it is shorter

Version 1.2, 26.04.2004

FIXED: after !recycle local file could be locked if downloading was in progress.

FIXED: semicolons in the extracted strings now would be replaced with "[semicolon]" escape-sequence to avoid situation when user needed to use !LabelNext/!LabelPrevious to read part of the text after semicolon

FIXED: !WazupSetInputString and !WazupSetOutputString didn't process escape-sequence "{%quote}"

When writing OutputString to file \n would be changed to new line character (use double backslash \\ in the pattern if you want to write a single backslash to the file \)

Added FileNewLine option. This can be used to write extracted strings in the single file line (for example, if you want to set $eVars$ this way)

Added !WazupSetLabelText bang to write text into the multiple labels

Added !WazupParseCommand bang to be able to use extracted strings in the other modules' !bangs

There is a new file in the "sample config" - weather.rc. It contain settings to grab weather info from www.weather.com. Originally posted by Brian Wolven in the LSML message.

Simple example of pattern usage.