Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 21 Feb 2015 12:27:52 -0500
From:      Allan Jude <allanjude@freebsd.org>
To:        freebsd-doc@freebsd.org
Subject:   Re: igor and xmllint
Message-ID:  <54E8C018.1080202@freebsd.org>
In-Reply-To: <20150221165145.GA2107@esprimo.local>
References:  <20150221165145.GA2107@esprimo.local>

index | next in thread | previous in thread | raw e-mail

[-- Attachment #1 --]
On 2015-02-21 11:51, Christoph Brinkhaus wrote:
> Hello,
> 
> I have read the fdp-primer but I am not sure about
> the verification of xml files.
> 
> In the quick start section igor is mentioned which
> works well. Unfortunaltely I have overlooked it first
> because it is just mentioned once.
> 
> In the other sections the files are checked by xmllint.
> On by system I have problems with xmllint. Even the self
> generated file a.txt can not be checked as below:
> 
> xmllint --valid --noout /home/chris/Projekte/a.txt 
> 
> The response is
> 
> /home/chris/Projekte/a.txt:2: validity error : Validation failed: no DTD found !
> <info>abc</info>
>      ^
> 
> 
> Does igor included the functions of xmllint or not?
> Is it necessary to verify a document ifirst by xmllint 
> and then by igor? Or is the test using igor enough?
> 
> I am using FreeBSD for about one year. Therefore I am not
> able to generate big documents which are valuable in terms
> of the content.
> 
> I can help in changing docuemnts and by translating to German.
> 
> Kind regards,
> 
> Christoph
> _______________________________________________
> freebsd-doc@freebsd.org mailing list
> http://lists.freebsd.org/mailman/listinfo/freebsd-doc
> To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org"
> 

igor is a perl script written by a FreeBSD Docs developer to catch
common mistakes. It looks to make you followed the conventions like two
spaces after a period, the correct indent level, catches common typos
and incorrect forms of works from the wordlist.

It is not the same as xmllint, which checks the validity of the xml.

XML documents require a DTD, which defines which elements are valid for
use in the document.

A typical article will look something like this:

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based
Extension//EN"
        "http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd">;
<article xmlns="http://docbook.org/ns/docbook"
  xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
  xml:lang="en"> <info>

which allows all of the docbook elements to be used.

-- 
Allan Jude


[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (MingW32)

iQIcBAEBAgAGBQJU6MAbAAoJEJrBFpNRJZKfsTUP/2u2RrX5G4koqVH8Qw6wjTm2
NL56463pUM4MHoTMkBbyqgUcIpul8n60ovJ2l29lsDLLYjr56uu9PDyDX0mSzrcH
b21KOU59pxRk3CwLUHGerpFj9kiD2KF7YDjEWZUr/TCFKLptnDrE8irTmACZDNeO
ddNvqNj02n+CrpYcZxDV/QFMCfV6xo7dfYZJYY1hNcRKMjIDlq0v63y8dxhtAG9G
fn5dvlWNNMcoqvTm6vVDfIeDjfCq9jBKp1hLLBwWk/KXU7BCbdxFutRYoj9ovwYZ
8RHLJ7Qvv+UZRJHSFnXmGpXoe42u+NGWpsX4AST1hWlXxdY48VP7NKsssUmUQZVf
WQqWswhbMnNu1RHvAbRR+UTy/23Vs7zleQAkr6ZHmZuQ3Yt5b0Q/kOlJlbkfaP2D
sxBWpmxndurDA6yEsFjNdqIYO4l1eXeBPQDNwr28IMCcuircp/fIJX6bfdlISpBt
llPkUJcK5BJbxKmROA9E4CLSQZLUHfCCrWzLLmf/UOt7hG2Jcx/wVDK1BPAx3+3W
vw0SK5xjhPtJLkGVHOXLYK4rkOmFjymSToBj+sz5BXns9UjmzUcXtFq/LTuzZP+q
e942lxEvNsmdBI/CUnKT5gOCt+DDUf9WLFSWFj64B2kSTeuCySDxbfjA96jBvtI2
vxAAdlRaiGQxoyj10J0Z
=PSO/
-----END PGP SIGNATURE-----
help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?54E8C018.1080202>