Command |
Mallard |
DocBook 4 |
DocBook 5 |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
|
Yes |
No |
No |
|
Yes |
No |
No |
|
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
|
Yes |
No |
No |
|
Yes |
No |
No |
|
Yes |
Yes |
Yes |
Check the target of all external links in a Mallard or DocBook
document. For Mallard documents, href attributes in the document. For DocBook
documents, it uses the url attribute of all
ulink elements as well as all xlink:href
attributes in the document. In both cases,
For Mallard documents, you can pass
If a URL is relative,
Check if the id attributes of pages match the base
file name (without the
Report the license of Mallard page files, taken from the
license element. The license is reported based on
the href attribute. The block content of the
license element is not used at all. For certain known licenses
(such as those from GNU and Creative Commons), a shortened
identifier is shown instead of the full URL. If a license
element does not have an href attribute, it is
listed as unknown.
Pages may have multiple license elements. If
they do, the license identifiers will all be reported, joined
with a comma. If a page has no license element, it is reported
as none.
You can restrict which licenses are shown using the following options:
Only show pages that have a license from the space-separated list LICENSES.
Only show pages that do not any license in the space-separated list LICENSES.
You can also get a summary of which licenses are in a document:
Instead of the normal output of , print a list of licenses along with the number of pages that have each license. All of the options above can still be used to filter the pages that are used to calculate the totals.
Check for references to external media files that do not exist. For
Mallard, media, ui:thumb, uix:thumb,
and e:mouseover elements are used. For DocBook, audiodata,
imagedata, and videodata elements are used.
Check the target of all internal links. For Mallard, all xref
attributes are used. For DocBook, all linkend attributes
are used. If the value does not correspond to an actual ID in the
document,
For Mallard documents, you can pass yelp-check links will only know about those pages,
and will report links as broken if they point to pages you did
not pass. However, you can create a cache file with
Mallard allows links to provide both an xref and
an href attribute, and defines implementations to use
the href when the xref is not understood.
Use the xref
attributes when an href attribute is also present.
For DocBook, you can pass any DocBook file, including any well-formed files that are included in a top-level file. However, if you only check a file that is meant to be included in another file, links will be reported as broken if they point to targets outside that file or the files it includes.
Check for Mallard pages that cannot be reached by topic links. You may still be able to reach the page by other links, but they do not appear in the primary topic navigation of the document.
You can pass
Report the status of Mallard page files, taken from the status attribute of the revision elements for each page. You can pass a list of page files, or pass a directory to process all page files in that directory.
A page may have more than one revision element. When this happens,
version, docversion, pkgversion,
and date attributes, depending on the arguments below.
It then sorts the revision elements primarily descending
by the date attribute, then by document order, and uses
the status attribute from the first. If the selected
revision element has no status attribute,
or if there are no matching revision elements, the status is
"none".
Only consider revision elements with a matching
version, docversion, or pkgversion
attribute, respectively. These options can be combined, and they
must all match. In all cases, VERSIONS can be a list
of versions separated by spaces or commas. The option matches if
any version matches the corresponding attribute.
Only consider revision elements with a date
attribute that comes before (
There are also options that change what is output.
After the status is determined as above, only print those
pages whose status matches (
Instead of the normal output of , print a list of statuses along with the number of pages that have each status. All of the options above can still be used to filter the revision elements and to limit which statuses the report on.
Validate files against a DTD or RNG schema.
For Mallard documents, version attribute. If
there is no version attribute on a page, it is assumed
to be "1.0", and the base Mallard 1.0 schema is used.
The Mallard schema allows elements and attributes from unknown
namespaces in many places, where the list of known namespaces is
built from the merged schemas. You can pass the
Disallow elements and attributes from namespaces that aren't
explicitly defined by the schemas imported based on the
version attribute.
When using strict validation, explicitly allow elements and
attributes from the namespace NAMESPACE in places
where any external-namespace nodes would normally be allowed.
You can pass the
For DocBook 4,
For DocBook 5, version attribute.
Print the editorial comments in a Mallard or DocBook document. Both Mallard and DocBook allow editors to embed remarks in a document that are not normally shown when formatting the document. (These remarks are displayed by Yelp when using the--editor-mode option.)
Mallard uses the
commentelement, and DocBook uses theremarkelement.For Mallard documents, you can passyelp-check comments
a list of page files, or you can pass it a directory to process all
page files in that directory. For DocBook, you can pass any DocBook
file, including any well-formed files that are included in a top-level
file.
Mallard comments are printed with the enclosing page and section ID, the author of the comment, and the date the comment was made. Mallard comments allow any block content, butyelp-check comments
cannot format all block content in plain text. Any content that is not
in a
pelement currently results in a FIXME statement.DocBook comments are printed with the closest enclosing ID and the value of the
revisionflagattribute.