home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / NEXTSTEP / UNIX / Web / Utilities / weblint-1.020-wof / weblintrc-wof < prev    next >
Encoding:
Text File  |  1997-10-09  |  17.7 KB  |  418 lines
  1. # hacqued for WOF by bbum
  2. #
  3. # sample configuration file for weblint
  4. # distributed as part of weblint 1.020
  5. #
  6. # The settings in this file reflect the built-in defaults.
  7. # I.e. if a warning is enabled in this file, then it is enabled by
  8. # default, and you don't have to enable it in your .weblintrc.
  9. #
  10.  
  11. #========================================================================
  12. #    Global Configuration File
  13. #========================================================================
  14. #
  15. # Weblint supports a local site configuration file.
  16. # If one is set up, then you can specify it be included with the following:
  17. #
  18. #    use global weblintrc
  19. #
  20.  
  21. #========================================================================
  22. #    Weblint Variables
  23. #========================================================================
  24.  
  25. #
  26. # message-style: style of warning message to generate
  27. #    lint    generate warnings similar to traditional lint:
  28. #            file(line #): warning
  29. #        this is the default
  30. #    short    don't include the filename in the warning message:
  31. #            line #: warning
  32. #    terse    a style which is easy for another program to parse:
  33. #            file:line #:warning-identifier
  34.  
  35. set message-style = lint
  36.  
  37. #
  38. # url-get: a program which can be used to retrieve a URL
  39. #
  40.  
  41. set url-get = lynx -source
  42.  
  43. #
  44. # directory-index: list of filenames for directory indices
  45. #
  46. # If your server supports multiple index file names:
  47. #    set directory-index = index.html, welcome.html
  48. #
  49.  
  50. set directory-index = index.html
  51.  
  52. #
  53. # file-extensions: list of filename extensions for valid HTML filenames
  54. #
  55. # A comma-separated list of filenames extensions; these are used when
  56. # recursing in a directory, to decide which files should be checked.
  57. #
  58.  
  59. set file-extensions = html, htm
  60.  
  61. #========================================================================
  62. #    Extensions
  63. #========================================================================
  64.  
  65. #------------------------------------------------------------------------
  66. # Allow Microsoft HTML extensions, such as MARQUEE
  67. #------------------------------------------------------------------------
  68. # uncomment following line to enable the Microsoft extensions
  69. extension Microsoft
  70.  
  71. #------------------------------------------------------------------------
  72. # Allow Netscape HTML extensions, such as CENTER and FONT
  73. #------------------------------------------------------------------------
  74. # uncomment following line to enable the Netscape extensions
  75. extension Netscape
  76.  
  77. #------------------------------------------------------------------------
  78. # Allow Apple's WebObjects HTML extensions (the WEBOBJECT tag)
  79. #------------------------------------------------------------------------
  80. # uncomment following line to enable the WebObjects extensions
  81. extension WebObjects
  82.  
  83. #========================================================================
  84. #    Weblint Warnings
  85. #========================================================================
  86.  
  87. #------------------------------------------------------------------------
  88. # By default, when recursing in a directory, weblint will check files
  89. # which are symlinks.  Uncomment the following line if you want weblint
  90. # to skip symlinks.  This is equivalent to the -l command-line switch
  91. #------------------------------------------------------------------------
  92. # ignore symlinks
  93.  
  94. #------------------------------------------------------------------------
  95. # There are two checks for the case of element tags:
  96. #    upper-case    all tags should be in upper case
  97. #    lower-case    all tags should be in lower case
  98. # If both are disabled, then case is ignored
  99. #------------------------------------------------------------------------
  100. disable upper-case lower-case
  101.  
  102. #------------------------------------------------------------------------
  103. # Bad style to use `here' as anchor text
  104. #------------------------------------------------------------------------
  105. enable here-anchor
  106.  
  107. #------------------------------------------------------------------------
  108. # Flag any elements which are not recognized.  This will catch mis-typed
  109. # elements (e.g. <TOTLE>, or <\BODY>).
  110. #------------------------------------------------------------------------
  111. enable unknown-element
  112.  
  113. #------------------------------------------------------------------------
  114. # check element attributes to see if they are legal
  115. #------------------------------------------------------------------------
  116. enable unknown-attribute
  117.  
  118. #------------------------------------------------------------------------
  119. # flag if no HEAD element in page
  120. #------------------------------------------------------------------------
  121. # enable require-head
  122.  
  123. # typically, this should be disabled for WOF
  124. disable require-head
  125.  
  126. #------------------------------------------------------------------------
  127. # Flag elements which should only appear once on a page (eg TITLE)
  128. #------------------------------------------------------------------------
  129. enable once-only
  130.  
  131. #------------------------------------------------------------------------
  132. # Flag case where page has BODY element, but no HEAD defined
  133. #------------------------------------------------------------------------
  134. enable body-no-head
  135.  
  136. #------------------------------------------------------------------------
  137. # If you want outer element to be <HTML>
  138. #------------------------------------------------------------------------
  139. # typically, this should be disabled for WOF
  140. disable html-outer
  141.  
  142. #------------------------------------------------------------------------
  143. # Flag elements which are only allowed to appear in HEAD element
  144. #------------------------------------------------------------------------
  145. enable head-element
  146.  
  147. #------------------------------------------------------------------------
  148. # Flag elements which aren't allowed to appear in HEAD element
  149. #------------------------------------------------------------------------
  150. enable non-head-element
  151.  
  152. #------------------------------------------------------------------------
  153. # Flag obsolete elements, such as XMP and LISTING
  154. #------------------------------------------------------------------------
  155. enable obsolete
  156.  
  157. #------------------------------------------------------------------------
  158. # Flag mis-matched begin and end tags;  for example:
  159. #    <H1> ... </H2>
  160. #------------------------------------------------------------------------
  161. enable mis-match
  162.  
  163. #------------------------------------------------------------------------
  164. # Flag any IMG elements which don't have ALT text defined.
  165. #------------------------------------------------------------------------
  166. enable img-alt
  167.  
  168. #------------------------------------------------------------------------
  169. # Flag illegally nested elements (such as anchors).
  170. #------------------------------------------------------------------------
  171. enable nested-element
  172.  
  173. #------------------------------------------------------------------------
  174. # Check for those elements which have required context.
  175. # For example, the <CAPTION> element can only appear in <FIG> or <TABLE>
  176. #------------------------------------------------------------------------
  177. enable required-context
  178.  
  179. #------------------------------------------------------------------------
  180. # Check for mailto: LINK in header;  for example:
  181. #    <LINK REV=MADE HREF="mailto:neilb@cre.canon.co.uk">
  182. # This lets at least lynx users comment on a page.
  183. #------------------------------------------------------------------------
  184. disable mailto-link
  185.  
  186. #------------------------------------------------------------------------
  187. # Flag overlapped elements.  For example:
  188. #    <A HREF="..."> <B> text </A> </B>
  189. #------------------------------------------------------------------------
  190. enable element-overlap
  191.  
  192. #------------------------------------------------------------------------
  193. # Generate a warning if closing tag is not seen for elements where
  194. # it is expected.  A common case is <A NAME="..."> ... </A>.
  195. #------------------------------------------------------------------------
  196. enable unclosed-element
  197.  
  198. #------------------------------------------------------------------------
  199. # Generate a warning if markup appears inside a comment.  This can
  200. # confuse quite a few browsers, so it's not a good idea to do it.
  201. #------------------------------------------------------------------------
  202. enable markup-in-comment
  203.  
  204. #------------------------------------------------------------------------
  205. # You are not allowed to have any whitespace between the opening
  206. # < and element name.
  207. #------------------------------------------------------------------------
  208. enable leading-whitespace
  209.  
  210. #------------------------------------------------------------------------
  211. # Flag potentially unclosed tags:
  212. #    < ... < ... >
  213. #------------------------------------------------------------------------
  214. enable unexpected-open
  215.  
  216. #------------------------------------------------------------------------
  217. # Elements which do not have any required attributes, but for which at
  218. # least one attribute is expected.  Anchors, for example.
  219. #------------------------------------------------------------------------
  220. enable expected-attribute
  221.  
  222. #------------------------------------------------------------------------
  223. # Required element attributes.  Eg IMG tag must have SRC attribute.
  224. #------------------------------------------------------------------------
  225. enable required-attribute
  226.  
  227. #------------------------------------------------------------------------
  228. # Currently just checks local links, to see if target file exists.
  229. # disabled at the moment, since it generates bogus warnings if the file
  230. # path included directories.
  231. #------------------------------------------------------------------------
  232. disable bad-link
  233.  
  234. #------------------------------------------------------------------------
  235. # Check for headings which are more than 1 level deeper than previous.
  236. # Example: <H1> followed by <H3>
  237. #------------------------------------------------------------------------
  238. disable heading-order
  239. # personal opinion
  240.  
  241. #------------------------------------------------------------------------
  242. # Check for odd number of double quotes in tag, to catch things like:
  243. #        <A HREF="url >
  244. #------------------------------------------------------------------------
  245. enable odd-quotes
  246.  
  247. #------------------------------------------------------------------------
  248. # Warn about closing tag for elements which don't take a closing tag.
  249. # For example: <IMG SRC="foo.gif" ALT="alt text"></IMG>
  250. #------------------------------------------------------------------------
  251. enable illegal-closing
  252.  
  253. #------------------------------------------------------------------------
  254. # Warn about unclosed comments.  For example:
  255. #    <!-- this comment is not correctly closed >
  256. # Legal SGML comments are:
  257. #    <!-- ... blah blah ... -->
  258. #------------------------------------------------------------------------
  259. enable unclosed-comment
  260.  
  261. #------------------------------------------------------------------------
  262. # Warning for use of physical font markup, rather than logical
  263. # For example:
  264. #    <B> where you should use <STRONG>
  265. #    <I> where you should use <EM>
  266. #    <TT> where you should use <CODE>, <KBD>, <VAR>, or <SAMP>
  267. #------------------------------------------------------------------------
  268. disable physical-font
  269.  
  270. #------------------------------------------------------------------------
  271. # Warning for repeated attributes within the same tag.  For example:
  272. #    <IMG SRC="foo.gif" SRC="bar.gif">
  273. #    <A NAME="fred" NAME="bloggs">
  274. #------------------------------------------------------------------------
  275. enable repeated-attribute
  276.  
  277. #------------------------------------------------------------------------
  278. # Warn against use of ' as a delimiter for attribute values.  E.g.:
  279. #    <A HREF='http://www.cre.canon.co.uk/'>Canon Research Centre</A>
  280. #------------------------------------------------------------------------
  281. enable attribute-delimiter
  282.  
  283. #------------------------------------------------------------------------
  284. # Warn about attributes on a closing tag of container element.  E.g.:
  285. #    <A HREF="foobar.html">click here!</A NAME="foobar">
  286. #------------------------------------------------------------------------
  287. enable closing-attribute
  288.  
  289. #------------------------------------------------------------------------
  290. # When recursing in a directory, check whether there is a directory
  291. # index file.  See also the variable `directory-index', which specifies
  292. # the name of index file to look for.
  293. #------------------------------------------------------------------------
  294. enable directory-index
  295.  
  296. #------------------------------------------------------------------------
  297. # Warn about empty container elements.  For example:
  298. #    <TITLE></TITLE>
  299. #------------------------------------------------------------------------
  300. enable empty-container
  301.  
  302. #------------------------------------------------------------------------
  303. # Warn about situations where one element is expected to immediately
  304. # follow another, with no tags or text between. For example:
  305. #    1) LH should be the first thing in a UL, if it appears at all
  306. #    2) should be nothing between </HEAD> and <BODY>
  307. #------------------------------------------------------------------------
  308. enable must-follow
  309.  
  310. #------------------------------------------------------------------------
  311. # Warn about IMG elements which don't have the WIDTH and HEIGHT
  312. # attributes set. Setting these attributes can improve page layout speed
  313. # on some browsers.
  314. #------------------------------------------------------------------------
  315. disable img-size
  316.  
  317. #------------------------------------------------------------------------
  318. # Warn about leading or trailing whitespace for certain container
  319. # elements: A, TITLE, H1 through H6.
  320. #------------------------------------------------------------------------
  321. disable container-whitespace
  322.  
  323. #------------------------------------------------------------------------
  324. # Warn if you don't have a DOCTYPE element as the first thing in
  325. # your document.
  326. #------------------------------------------------------------------------
  327. disable require-doctype
  328.  
  329. #------------------------------------------------------------------------
  330. # Warn if you a metacharacter is included literally, rather than using
  331. # the appropriate entity. Currently this just warns about use of >,
  332. # in which case you should use >
  333. #------------------------------------------------------------------------
  334. enable literal-metacharacter
  335.  
  336. # ========================================================================
  337. # Warnings added in the 1.014 release
  338. # ========================================================================
  339.  
  340. #------------------------------------------------------------------------
  341. # Warn if a heading is closed with a different level close tag than
  342. # the heading was opened with. For example:
  343. #    <H2>... blah blah ...</H1>
  344. #------------------------------------------------------------------------
  345. enable heading-mismatch
  346.  
  347. #------------------------------------------------------------------------
  348. # Warn if text is seen in unexpected context, such as inside a UL element
  349. # (rather than inside an LI, which is inside a UL. Or in the HEAD element.
  350. #------------------------------------------------------------------------
  351. enable bad-text-context
  352.  
  353. #------------------------------------------------------------------------
  354. # Warn about illegal attribute values, such as values in the wrong format.
  355. #------------------------------------------------------------------------
  356. enable attribute-format
  357.  
  358. # ========================================================================
  359. # Warnings added in the 1.015 release  
  360. #       NOTE: the netscape-markup and netscape-attribute warnings
  361. #               were deleted with the 1.015 release
  362. # ========================================================================
  363.  
  364. # uncomment the following line if using the Microsoft HTML extensions
  365. # extension Microsoft
  366.  
  367. #------------------------------------------------------------------------
  368. # Warn if using extended markup without an appropriate extension enabled.
  369. # This warning replaces the 'netscape-markup' warning, and is now generated
  370. # if the page uses Netscape or Microsoft extensions.
  371. #------------------------------------------------------------------------
  372. enable extension-markup
  373.  
  374. #------------------------------------------------------------------------
  375. # Warn if using extended attributes without an appropriate extension enabled.
  376. # This warning replaces the 'netscape-attribute' warning, and is now generated
  377. # if the page uses Netscape or Microsoft attributes.
  378. #------------------------------------------------------------------------
  379. enable extension-attribute
  380.  
  381.  
  382. # ========================================================================
  383. # New stuff in the 1.016 release
  384. # ========================================================================
  385.  
  386. #------------------------------------------------------------------------
  387. # Warn of the document TITLE is longer than 64 characters.
  388. # This limit is recommended by the HTML specification
  389. #------------------------------------------------------------------------
  390. enable title-length
  391.  
  392. #------------------------------------------------------------------------
  393. # Warn about a heading inside an anchor. Should be the other way round;
  394. # i.e. an anchor inside a heading.
  395. #------------------------------------------------------------------------
  396. enable heading-in-anchor
  397.  
  398. #------------------------------------------------------------------------
  399. # Warn about use of < inside the PRE element. This is just a special
  400. # case of the `literal-metacharacter' warning.
  401. #------------------------------------------------------------------------
  402. enable meta-in-pre
  403.  
  404. #------------------------------------------------------------------------
  405. # Warn about attribute values which should be quoted, but aren't.
  406. # Attribute values should be quoted if they contain characters
  407. # other than [-.A-Za-z0-9]
  408. #------------------------------------------------------------------------
  409. enable quote-attribute-value
  410.  
  411.  
  412. # ========================================================================
  413. # New stuff in the 1.020 release
  414. # ========================================================================
  415.  
  416. #-- no new warnings or variables added in 1.020
  417.  
  418.