-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplate.wd
More file actions
110 lines (107 loc) · 4.97 KB
/
Copy pathtemplate.wd
File metadata and controls
110 lines (107 loc) · 4.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# Basic rules for setting up a .wd config file
#
# 1. A .wd file may contain settings for as many web pages
# or other content as desired.
#
# 2. Options/Fields for a given piece of content must be grouped
# in sequential order.
#
# 3. The first option of a given piece of content must start with
# a dash "-" and a space. It is recommended but not required
# that the first option given for an item is its "id".
#
# 4. All subsequent options must be indented to the same indentation
# level as the first option in the group. The indentation for the
# first option starts with the option name and not its preceding dash.
# Be careful about mixing tabs and spacing, as they are interpreted
# differently. It common to use 2 spaces for indentation and
# recommended that tabs not be used.
#
# 5. Option names are to be followed by a colon ":", a space, and the
# value for the option. It is permitted to have multiple white space
# characters between the colon and the value. Additional space are
# commonly put in to align all values on the same column, making the
# file more readable.
#
# 6. Some options support multiple entries. When listing multiple items
# use the from: [item1, item2, item3, ...itemN]. When a single item
# is to used on a field that supports multiple items, the single item
# will need to be placed in brackets like this: [item]. Currently the
# only two options that support multiple items are "mail" and "rule".
#
# 7. To prevent a *.wd file from being loaded when webdiffer runs, rename
# the file with a different file extension. The standard practice is to
# change the file extension from ".wd" to ".wd_".
#
#
# Required Fields
#
# id -- The "id" field is used to give each content item a unique name. The id
# is used internally for variable names, as well as externally in the
# names of supporting log files. This will also be the name used in messages
# to notify users of a change in content. Typically the "id" field will be
# the first option listed in a content block, and thus should be preceded
# by a dash "-" and a space:
# - id: google
# Id names should be made up of only alpha numeric characters and underscores.
# No spaces or dashes should appear in the name.
#
# type -- This field represents the type of content to be monitored. Currently
# only web page monitoring is supported:
# type: webpage
#
# url -- This option will contain the url/link to the content to be monitored.
# It is important that the full url is used, i.e. "http://", "https://",
# or "ftp://" should be included:
# url: http://www.google.com
#
# mail -- This option contains a list of e-mail addresses that are to be notified
# when the content has changed. The e-mail addresses should be contained
# in a set of brackets "[]" and separated by commas:
# mail: [steve@gmail.com, charles@yahoo.com, travis@hotmail.com]
# If there is only one e-mail address, it should still be enclosed in brackets:
# mail: [scott@gmail.com]
#
#
# Optional Fields
#
# rule -- Some web pages have dynamic content, which can change on a frequent basis.
# If the changes are unimportant and the user would like to ignore them, a
# "rule" will have to be created. The rule will be a list of "regular
# expressions" enclosed in single quotes and separated by commas:
# rule: ['regex1', 'regex2', 'regex3']
# The regular expressions should represent the block of HTML code that is
# to be ignored. Setting up these rules will require basic knowledge of
# HTML and regular expressions, the following links may be helpful:
# http://www.w3schools.com/html/html_intro.asp
# http://www.regular-expressions.info/tutorial.html
#
# user -- When using basic web authentication the "user" option is added to
# specify the user name to be entered when logging into the web page:
# user: user_name
# Some times a web page only requires a password and the user name is not
# used. In this case the user option should still be used, but the no name
# will be specified at the end of the option:
# user:
#
# pass -- When using basic web authentication the "pass" option is added to
# specify the password to be entered when logging into the web page:
# pass: password
#
#
# EXAMPLES
- id: google
type: webpage
url: http://www.google.com
mail: [scott.hodgin@libtax.com]
rule: ['<script>[^<]*</script>']
- id: yahoo
type: webpage
url: http://www.yahoo.com
mail: [scott.hodgin@libtax.com, scotthodgin@gmail.com]
- id: MS_New
type: webpage
user: liber
pass: liber246
url: https://www.mstc.state.ms.us/nactp/news/main.htm
mail: [scott.hodgin@libtax.com, scotthodgin@gmail.com]