inspection report complains about *LC* in generated HTML files
Hi all. The inspection report is complaining about *LC* in a generated file -- doc/html/typeof.html (as well as some other HTML files in this directory). I wonder how this issue should be addressed. The licence/copyright info is supplied to the quickbook, and appears in the visual representation of the document. Maybe quickbook should also generate the license/copyright comment for the HTML file itself? Regards, Arkadiy
Arkadiy Vertleyb wrote:
Hi all.
The inspection report is complaining about *LC* in a generated file -- doc/html/typeof.html (as well as some other HTML files in this directory). I wonder how this issue should be addressed. The licence/copyright info is supplied to the quickbook, and appears in the visual representation of the document. Maybe quickbook should also generate the license/copyright comment for the HTML file itself?
No, clearly that's a job of BoostBook/DocBook and the XSL. This pertains to the legalnotice tag (see http://tinyurl.com/mpx2m) where "in printed documents, they often occur on the verso of the title page, sometimes in a reduced font size. Online, they may occur on the title page or in a separate document behind a hypertext link." I am not sure how to tweak the XSL to show the legalnotice in all pages. I'm cross-posting to the Boost.Docs. Maybe someone more knowledgeable than me can help. Regards, -- Joel de Guzman http://www.boost-consulting.com http://spirit.sf.net
On 18/09/06, Arkadiy Vertleyb <vertleyb@hotmail.com> wrote:
The inspection report is complaining about *LC* in a generated file -- doc/html/typeof.html (as well as some other HTML files in this directory). I wonder how this issue should be addressed. The licence/copyright info is supplied to the quickbook, and appears in the visual representation of the document. Maybe quickbook should also generate the license/copyright comment for the HTML file itself?
The emailled inspection report is actually complaining about the handwritten redirection files from CVS. doc/html/typeof.html is one of several that I added. I'll add a copyright to all the ones I created if necessary, although it feels a little odd as I just copied the redirection file from a different library and used sed to fix the links. Although, I agree that it'd be a good idea to have the copyright notice in the generated files - they'll be included in the release, and there are places where they're stored in CVS (such as the quickbook documentation).
"Daniel James" <daniel_james@fmail.co.uk> writes:
The emailled inspection report is actually complaining about the handwritten redirection files from CVS. doc/html/typeof.html is one of several that I added. I'll add a copyright to all the ones I created if necessary, although it feels a little odd as I just copied the redirection file from a different library and used sed to fix the links.
That's what happens when you use copy/paste on a file that's already failing inspection. Doesn't that make sense? -- Dave Abrahams Boost Consulting www.boost-consulting.com
On 18/09/06, David Abrahams <dave@boost-consulting.com> wrote:
That's what happens when you use copy/paste on a file that's already failing inspection. Doesn't that make sense?
I meant it was odd to claim copyright for something I copied. Since it isn't my work.
"Daniel James" <daniel_james@fmail.co.uk> writes:
On 18/09/06, David Abrahams <dave@boost-consulting.com> wrote:
That's what happens when you use copy/paste on a file that's already failing inspection. Doesn't that make sense?
I meant it was odd to claim copyright for something I copied. Since it isn't my work.
Aha. You can always look in the CVS history to see who checked in the original, and assign copyright to that person. -- Dave Abrahams Boost Consulting www.boost-consulting.com
participants (4)
-
Arkadiy Vertleyb -
Daniel James -
David Abrahams -
Joel de Guzman