Add an easy way to license documentation
Submitted by Philip Withnall
People very rarely make it obvious what license their gtk-doc documentation is under. Typically, it’s under the same license as the code it was generated from (otherwise you raise some interesting questions about whether the documentation comments in the source code are dual licenced). This should be made a bit more obvious in the generated documentation, especially in the HTML documentation which is often copied to multiple sites.
How about adding a DOC_LICENSE variable to gtk-doc.make which passes some magic flags into the various gtkdoc-* utilities to:
- Add schema.org metadata to the HTML output: http://schema.org/license
- Add rel="license" microformat to the HTML output: http://microformats.org/wiki/rel-license
- Add itemref="licenses" microdata to the HTML output: http://www.w3.org/TR/microdata/#attr-itemref
- Add CC RDF metadata to the HTML output: https://wiki.creativecommons.org/Metadata
- Add CC RDF metadata to the DocBook output: https://wiki.creativecommons.org/Metadata
- Add a
<copyright>element to the DocBook output: http://www.docbook.org/tdg/en/html/copyright.html
- Add CC XMP metadata to the PDF output: https://wiki.creativecommons.org/XMP
- Add a brief bit of licence text to the bottom of the index page of each output format stating the licence name and a link to the licence text. Might also want to include the full licence text somewhere, to handle the common case where the documentation is copied separately from the source code tarball?
DOCBOOK_LICENSE would accept various well-defined values, e.g. the ‘Short Name’ values from https://fedoraproject.org/wiki/Licensing:Main?rd=Licensing#Good_Licenses_2.