diff options
author | Vivien Kraus <vivien@planete-kraus.eu> | 2020-12-07 21:51:24 +0100 |
---|---|---|
committer | Vivien Kraus <vivien@planete-kraus.eu> | 2021-05-11 00:14:27 +0200 |
commit | 84dcc91c1001c8a6499a58596ac6edaf40c80d97 (patch) | |
tree | 54d60ec7dc68d783c0b768314295d26c42f3d807 | |
parent | 1cdb9d106b5d3df0c46a751dca2e7b7ab8e42c90 (diff) |
Set up the manual
-rw-r--r-- | Makefile.am | 1 | ||||
-rwxr-xr-x | bootstrap | 4 | ||||
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | doc/Makefile.am | 14 | ||||
-rw-r--r-- | doc/fdl.texi | 505 | ||||
-rw-r--r-- | doc/html2texi.xsl | 367 | ||||
-rw-r--r-- | doc/manual.html | 118 | ||||
-rw-r--r-- | doc/style.css | 31 | ||||
-rw-r--r-- | guix/vkraus/packages/webid-oidc.scm | 6 | ||||
-rw-r--r-- | po/fr.po | 2 | ||||
-rw-r--r-- | po/webid-oidc.pot | 2 |
11 files changed, 1047 insertions, 4 deletions
diff --git a/Makefile.am b/Makefile.am index fcfde44..6e77a42 100644 --- a/Makefile.am +++ b/Makefile.am @@ -11,6 +11,7 @@ AM_CPPFLAGS = -DLOCALEDIR=\"$(localedir)\" -I. -I$(srcdir) AM_CFLAGS = $(GUILE_CFLAGS) $(NETTLE_CFLAGS) include src/Makefile.am +include doc/Makefile.am EXTRA_DIST += $(top_srcdir)/.version BUILT_SOURCES += $(top_srcdir)/.version @@ -1,6 +1,10 @@ #!/bin/sh +(echo '\input texinfo' ; + echo '@include version.texi') \ + > doc/webid-oidc.texi || exit 1 autoreconf -vif || exit 1 +rm doc/webid-oidc.texi || exit 1 sed -i 's|SHELL = /bin/sh|SHELL = @SHELL@|g' po/Makefile.in.in || exit 1 ## Prepare the man pages diff --git a/configure.ac b/configure.ac index 44d902b..0331d87 100644 --- a/configure.ac +++ b/configure.ac @@ -6,6 +6,7 @@ AM_SILENT_RULES([yes]) AC_PROG_CC AM_MISSING_PROG([SNARF], [guile-snarf]) AM_MISSING_PROG([HELP2MAN], [help2man]) +AM_MISSING_PROG([XSLTPROC], [xsltproc]) LT_INIT AC_CONFIG_HEADERS([config.h]) AM_GNU_GETTEXT([external]) diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..eae1187 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,14 @@ +EXTRA_DIST += %reldir%/html2texi.xsl \ + %reldir%/manual.html \ + %reldir%/webid-oidc.texi \ + %reldir%/fdl.texi + +info_TEXINFOS = %reldir%/webid-oidc.texi +%canon_reldir%_webid_oidc_texi_TEXINFOS = %reldir%/fdl.texi + +AM_MAKEINFOHTMLFLAGS = --css-include=doc/style.css + +%reldir%/Makefile.am: %reldir%/webid-oidc.texi + +$(srcdir)/%reldir%/webid-oidc.texi: %reldir%/html2texi.xsl %reldir%/manual.html + $(AM_V_GEN) $(XSLTPROC) $^ > $@-t && mv $@-t $@ diff --git a/doc/fdl.texi b/doc/fdl.texi new file mode 100644 index 0000000..eaf3da0 --- /dev/null +++ b/doc/fdl.texi @@ -0,0 +1,505 @@ +@c The GNU Free Documentation License. +@center Version 1.3, 3 November 2008 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +@uref{https://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{free} in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG@. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The ``publisher'' means any person or entity that distributes copies +of the Document to the public. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled ``History'' +in the various original documents, forming one section Entitled +``History''; likewise combine any sections Entitled ``Acknowledgements'', +and any sections Entitled ``Dedications''. You must delete all +sections Entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{https://www.gnu.org/licenses/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +@item +RELICENSING + +``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +site means any set of copyrightable works thus published on the MMC +site. + +``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +``Incorporate'' means to publish or republish a Document, in whole or +in part, as part of another Document. + +An MMC is ``eligible for relicensing'' if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.''@: line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: diff --git a/doc/html2texi.xsl b/doc/html2texi.xsl new file mode 100644 index 0000000..dc432c6 --- /dev/null +++ b/doc/html2texi.xsl @@ -0,0 +1,367 @@ +<?xml version="1.0" encoding="utf-8"?> +<xsl:stylesheet + version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:html="http://www.w3.org/1999/xhtml" + xmlns:info="http://planete-kraus.eu/ns/info"> + + <xsl:output method="text"/> + + <xsl:template match="html:html"> + <xsl:text>\input texinfo @c -*-texinfo-*-
</xsl:text> + <xsl:text>@comment $Id@w{$}
</xsl:text> + <xsl:if test="@xml:lang"> + <xsl:text>@documentlanguage </xsl:text> + <xsl:value-of select="@xml:lang" /> + <xsl:text>
</xsl:text> + </xsl:if> + <xsl:apply-templates select="html:head" /> + <xsl:text>@contents
</xsl:text> + <xsl:apply-templates select="html:body" /> + <xsl:text>@bye
</xsl:text> + </xsl:template> + + <xsl:template match="html:head"> + <xsl:text>@comment %**start of header
</xsl:text> + <xsl:text>@include version.texi
</xsl:text> + <xsl:text>@settitle </xsl:text> + <xsl:apply-templates select="html:title" /> + <xsl:text>
</xsl:text> + <xsl:text>@syncodeindex pg cp
</xsl:text> + <xsl:text>@syncodeindex fn cp
</xsl:text> + <xsl:text>@syncodeindex vr cp
</xsl:text> + <xsl:text>@syncodeindex tp cp
</xsl:text> + <xsl:text>@comment %**end of header
</xsl:text> + <xsl:text>
</xsl:text> + <xsl:apply-templates select="info:copying" /> + <xsl:text>
</xsl:text> + <xsl:apply-templates select="info:dircategory" /> + <xsl:text>
</xsl:text> + <xsl:apply-templates select="info:direntry" /> + <xsl:text>
</xsl:text> + <xsl:text>@titlepage
</xsl:text> + <xsl:text>@title </xsl:text> + <xsl:apply-templates select="html:title" /> + <xsl:text>
</xsl:text> + <xsl:text>@subtitle for version @value{VERSION}, @value{UPDATED}
</xsl:text> + <xsl:text>@author </xsl:text> + <xsl:apply-templates select="info:author" /> + <xsl:text>
</xsl:text> + <xsl:text>@page
</xsl:text> + <xsl:text>@vskip 0pt plus 1fill
</xsl:text> + <xsl:text>@insertcopying
</xsl:text> + <xsl:text>@end titlepage
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:copying"> + <xsl:text>@copying
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end copying
</xsl:text> + </xsl:template> + + <xsl:template match="info:quotation"> + <xsl:text>@quotation
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end quotation
</xsl:text> + </xsl:template> + + <xsl:template match="info:version"> + <xsl:text>@value{VERSION}</xsl:text> + </xsl:template> + + <xsl:template match="info:updated"> + <xsl:text>@value{UPDATED}</xsl:text> + </xsl:template> + + <xsl:template match="info:copyright-symbol"> + <xsl:text>@copyright{}</xsl:text> + </xsl:template> + + <xsl:template match="info:dircategory"> + <xsl:text>@dircategory </xsl:text> + <xsl:apply-templates /> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:direntry"> + <xsl:text>@direntry
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end direntry
</xsl:text> + </xsl:template> + + <xsl:template match="info:direntry-entry"> + <xsl:text>* </xsl:text> + <xsl:value-of select="@name" /> + <xsl:text>: (</xsl:text> + <xsl:value-of select="@name" /> + <xsl:text>)</xsl:text> + <xsl:apply-templates /> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:author"> + <xsl:apply-templates /> + </xsl:template> + + <xsl:template match="html:a[starts-with(@href, 'mailto:')]"> + <xsl:apply-templates /> + <xsl:text> (@email{</xsl:text> + <xsl:variable name="address" select="substring-after(@href, 'mailto:')" /> + <xsl:value-of select="substring-before($address, '@')" /> + <xsl:text>@@</xsl:text> + <xsl:value-of select="substring-after($address, '@')" /> + <xsl:text>})</xsl:text> + </xsl:template> + + <xsl:template match="html:body"> + <xsl:text>@ifnottex
</xsl:text> + <xsl:text>@node Top
</xsl:text> + <xsl:text>@top Webid-oidc
</xsl:text> + <xsl:apply-templates select="child::*[not(self::html:h1) and count(preceding-sibling::html:h1) = 0]" /> + <xsl:text>@end ifnottex
</xsl:text> + <xsl:text>
</xsl:text> + <xsl:text>@menu
</xsl:text> + <xsl:apply-templates mode="menu" select="html:h1" /> + <xsl:text>@end menu
</xsl:text> + <xsl:text>
</xsl:text> + <xsl:apply-templates select="child::*[self::html:h1 or count(preceding-sibling::html:h1) >= 1]" /> + </xsl:template> + + <xsl:template match="*" mode="menu"> + <xsl:text>* </xsl:text> + <xsl:apply-templates /> + <xsl:text>::
</xsl:text> + </xsl:template> + + <xsl:template match="html:h1"> + <xsl:text>@node </xsl:text> + <xsl:apply-templates /> + <xsl:text>
</xsl:text> + <xsl:text>@</xsl:text> + <xsl:choose> + <xsl:when test="@type"> + <xsl:value-of select="@type" /> + </xsl:when> + <xsl:otherwise> + <xsl:text>chapter</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text> </xsl:text> + <xsl:apply-templates /> + <xsl:text>
</xsl:text> + <xsl:text>
</xsl:text> + <xsl:variable name="chapter-number" + select="count(preceding-sibling::html:h1) + 1" /> + <xsl:if test="count(following-sibling::html:h2[count(preceding-sibling::html:h1) = $chapter-number]) > 0"> + <!-- There are sub-sections; we need a menu --> + <xsl:text>@menu
</xsl:text> + <xsl:apply-templates mode="menu" + select="following-sibling::html:h2[count(preceding-sibling::html:h1) = $chapter-number]" /> + <xsl:text>@end menu
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template match="html:h2"> + <xsl:text>@node </xsl:text> + <xsl:apply-templates /> + <xsl:text>
</xsl:text> + <xsl:text>@section </xsl:text> + <xsl:apply-templates /> + <xsl:text>
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="text()"> + <!-- Normalize the spaces, but keep one space before or after if + needed --> + <xsl:variable name="normalized" select="normalize-space(.)" /> + <xsl:variable name="first-char"> + <xsl:value-of select="substring(., 1, 1)" /> + </xsl:variable> + <xsl:variable name="last-char"> + <xsl:value-of select="substring(., string-length(.))" /> + </xsl:variable> + <xsl:variable name="first-char-space"> + <xsl:if test="$first-char = ' ' or $first-char = '	' or $first-char = '
'"> + <xsl:text> </xsl:text> + </xsl:if> + </xsl:variable> + <xsl:variable name="last-char-space"> + <xsl:if test="$last-char = ' ' or $last-char = '	' or $last-char = '
'"> + <xsl:text> </xsl:text> + </xsl:if> + </xsl:variable> + <xsl:variable name="space-left"> + <xsl:if test="count(preceding-sibling::*) >= 1 "> + <xsl:value-of select="$first-char-space" /> + </xsl:if> + </xsl:variable> + <xsl:variable name="space-right"> + <xsl:if test="count(following-sibling::*) >= 1 "> + <xsl:value-of select="$last-char-space" /> + </xsl:if> + </xsl:variable> + <xsl:if test="$normalized != ''"> + <xsl:value-of select="$space-left" /> + <xsl:value-of select="$normalized" /> + <xsl:value-of select="$space-right" /> + </xsl:if> + </xsl:template> + + <xsl:template match="html:p[position() < last()]"> + <!-- Leave an empty line --> + <xsl:apply-templates /> + <xsl:text>@c fill
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="html:p"> + <xsl:apply-templates /> + <xsl:text>@c fill
</xsl:text> + </xsl:template> + + <xsl:template match="info:dfn"> + <xsl:text>@dfn{</xsl:text> + <xsl:apply-templates /> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="html:pre"> + <xsl:text>@code{</xsl:text> + <xsl:apply-templates /> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="info:deffn"> + <xsl:text>@deffn </xsl:text> + <xsl:value-of select="@type" /> + <xsl:text> </xsl:text> + <xsl:value-of select="@name" /> + <xsl:text> </xsl:text> + <xsl:call-template name="arglist"> + <xsl:with-param name="arguments" select="@arguments" /> + </xsl:call-template> + <xsl:text>
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end deffn
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:deffnx"> + <xsl:text>@deffnx </xsl:text> + <xsl:value-of select="@type" /> + <xsl:text> </xsl:text> + <xsl:value-of select="@name" /> + <xsl:text> </xsl:text> + <xsl:call-template name="arglist"> + <xsl:with-param name="arguments" select="@arguments" /> + </xsl:call-template> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:defvr"> + <xsl:text>@defvr {</xsl:text> + <xsl:value-of select="@type" /> + <xsl:text>} </xsl:text> + <xsl:value-of select="@name" /> + <xsl:text>
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end defvr
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:deftp"> + <xsl:text>@deftp {</xsl:text> + <xsl:value-of select="@type" /> + <xsl:text>} </xsl:text> + <xsl:value-of select="@name" /> + <xsl:text> </xsl:text> + <xsl:call-template name="arglist"> + <xsl:with-param name="arguments" select="@arguments" /> + </xsl:call-template> + <xsl:text>
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end deftp
</xsl:text> + <xsl:text>
</xsl:text> + </xsl:template> + + <xsl:template match="info:var"> + <xsl:call-template name="arglist"> + <xsl:with-param name="arguments"> + <xsl:apply-templates /> + </xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template name="arglist"> + <xsl:param name="arguments" /> + <xsl:variable name="content" select="normalize-space($arguments)" /> + <xsl:choose> + <xsl:when test="contains($content, ' ')"> + <xsl:call-template name="arglist"> + <xsl:with-param + name="arguments" + select="substring-before($content, ' ')" /> + </xsl:call-template> + <xsl:text> </xsl:text> + <xsl:call-template name="arglist"> + <xsl:with-param + name="arguments" + select="substring-after($content, ' ')" /> + </xsl:call-template> + </xsl:when> + <xsl:when test="$content != ''"> + <xsl:text>@var{</xsl:text> + <xsl:value-of select="$content" /> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise /> + </xsl:choose> + </xsl:template> + + <xsl:template match="html:strong"> + <xsl:text>@strong{</xsl:text> + <xsl:apply-templates /> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="html:ul"> + <xsl:text>@itemize
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end itemize
</xsl:text> + </xsl:template> + + <xsl:template match="html:ol"> + <xsl:text>@enumerate
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@end enumerate
</xsl:text> + </xsl:template> + + <xsl:template match="html:li"> + <xsl:text>@item
</xsl:text> + <xsl:apply-templates /> + <xsl:text>@c fill
</xsl:text> + </xsl:template> + + <xsl:template match="html:emph"> + <xsl:text>@emph{</xsl:text> + <xsl:apply-templates /> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="info:var"> + <xsl:text>@var{</xsl:text> + <xsl:apply-templates /> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="info:gfdl"> + <xsl:text>@include fdl.texi

</xsl:text> + </xsl:template> + + <xsl:template match="info:printindex"> + <xsl:text>@printindex cp

</xsl:text> + </xsl:template> +</xsl:stylesheet> diff --git a/doc/manual.html b/doc/manual.html new file mode 100644 index 0000000..1b17e75 --- /dev/null +++ b/doc/manual.html @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<html xmlns="http://www.w3.org/1999/xhtml" + xmlns:info="http://planete-kraus.eu/ns/info" + xml:lang="en"> + <head> + <link rel="stylesheet" type="text/css" href="style.css"/> + <title>Webid-oidc manual</title> + <info:subtitle>for version <info:version />, + <info:updated /></info:subtitle> + <info:copying> + <p> + This is the manual of webid-oidc (version <info:version />, + <info:updated />), an implementation of the Solid + authentication protocol for guile, client and server. + </p> + <p>Copyright <info:copyright-symbol /> 2020, 2021 Vivien + Kraus</p> + <info:quotation> + <p> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License, Version 1.3 or any later version published by the + Free Software Foundation; with no Invariant Sections, with no + Front-Cover Texts, and with no Back-Cover Texts. A copy of the + license is included in the section entitled ``GNU Free + Documentation License'' + </p> + </info:quotation> + </info:copying> + <info:author> + <a href="mailto:vivien@planete-kraus.eu">Vivien Kraus</a> + </info:author> + <info:dircategory> + Software libraries + </info:dircategory> + <info:direntry> + <info:direntry-entry name="webid-oidc"> + Decentralized Authentication on the Web. + </info:direntry-entry> + </info:direntry> + </head> + <body> + <h1>Decentralized Authentication on the Web</h1> + <p> + Authentication on the web is currently handled in the following + way: anyone can install a server that will authenticate users on + the web. The problem is interoperability. If a client (an + application) wants to authenticate a user, it has to be approved + by the authentication server. In other words, if + <info:var>useful-program</info:var> wants to authenticate + <info:var>MegaCorp</info:var> users, then + <info:var>useful-program</info:var> has to register to + <info:var>MegaCorp</info:var> first, and get approved. This goes + against the principle of permission-less innovation, which is at + the heart of the web. + </p> + <p> + In the decentralized authentication web, the best attempt so far + is that of ActivityPub. All servers are interoperable with + respect to authentication: if user A emits an activity, it is + forwarded by A's server to its recipients, and A's server is + responsible for A's identity. + </p> + <p> + The problem with that approach is that the data is tied to the + application. It is not possible to use another application to + process the data differently, or to use multiple data sources, + in an interoperable way (without the ActivityPub server + knowing). This means that on Activitypub, microblogging + applications will not present different activities + correctly. This also means that it is difficult to write a free + replacement to a non-free application program, because it would + need to manage the data. + </p> + <p> + In the Solid ecosystem, there is a clear distinction between + servers and applications. An application is free to read data + from all places at the same time, using a permission-less + authentication system. Since the applications do not need to + store data, the cost of having users is neglectible, so users do + not need prior approval before using them (making captchas and + the like a thing of the past). Servers do not have a say in + which applications the user uses. + </p> + <p> + The authentication used is a slight modification of the + well-established OpenID Connect. It is intended to work in a web + browser, but this package demonstrates that it also works + without a web browser. + </p> + <h1>The Json Web Token</h1> + <p> + The Json Web Token, or <info:dfn>JWT</info:dfn>, is a terse + representation of a pair of JSON objects: the + <info:dfn>header</info:dfn>, and the + <info:dfn>payload</info:dfn>. The JWT can be + <info:dfn>encoded</info:dfn> as a Json Web Signature + (<info:dfn>JWS</info:dfn>), in which case the header is encoded + to base64 with the URL alphabet, and without padding characters, + the payload is also encoded to base64, and the concatenation of + the encoding of the header, a dot, and the encoding of the + payload is signed with some cryptography algorithm. In the + following, we will only be interested by public-key + cryptography. The concatenation of header, dot, payload, dot and + signature in base64 is the encoding of the JWT. + </p> + + <h1 type="appendix">GNU Free Documentation License</h1> + <info:gfdl /> + + <h1 type="unnumbered">Index</h1> + <info:printindex /> + </body> +</html> + +<!-- Local Variables: --> +<!-- mode: nxml --> +<!-- End: --> diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..f201219 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,31 @@ +html { + background-color: silver; +} + +body { + max-width: 50em; + margin: auto; + background-color: white; + padding: 2em; + border-left: 5px solid grey; + border-right: 2px solid grey; +} + +.example > .example { + border-left: 1px solid grey; + padding-left: 1em; +} + +.float-caption { + border-left: 1em solid lightgrey; + border-bottom: 2px solid grey; + margin-bottom: 6ex; + padding-left: 1em; +} + +dd { + border-left: 1em solid lightgrey; + border-bottom: 2px solid lightgrey; + margin-left: 1em; + padding-left: 1em; +} diff --git a/guix/vkraus/packages/webid-oidc.scm b/guix/vkraus/packages/webid-oidc.scm index 6be13fa..0d971e8 100644 --- a/guix/vkraus/packages/webid-oidc.scm +++ b/guix/vkraus/packages/webid-oidc.scm @@ -15,7 +15,8 @@ #:use-module (gnu packages autotools) #:use-module (gnu packages gettext) #:use-module (gnu packages man) - #:use-module (gnu packages tls)) + #:use-module (gnu packages tls) + #:use-module (gnu packages xml)) (define-public webid-oidc-snapshot (package @@ -73,7 +74,8 @@ ("gettext" ,gnu-gettext) ("coreutils" ,coreutils) ;; for link (wrap-program) ("help2man" ,help2man) - ("which" ,which))) + ("which" ,which) + ("libxslt" ,libxslt))) (inputs `(("guile" ,guile-3.0) ("nettle" ,nettle))) (propagated-inputs @@ -2,7 +2,7 @@ msgid "" msgstr "" "Project-Id-Version: webid-oidc 0.0.0\n" "Report-Msgid-Bugs-To: vivien@planete-kraus.eu\n" -"POT-Creation-Date: 2021-05-10 14:42+0200\n" +"POT-Creation-Date: 2021-05-10 14:43+0200\n" "PO-Revision-Date: 2021-05-10 14:31+0200\n" "Last-Translator: Vivien Kraus <vivien@planete-kraus.eu>\n" "Language-Team: French <vivien@planete-kraus.eu>\n" diff --git a/po/webid-oidc.pot b/po/webid-oidc.pot index a463f1b..d16a1df 100644 --- a/po/webid-oidc.pot +++ b/po/webid-oidc.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: webid-oidc SNAPSHOT\n" "Report-Msgid-Bugs-To: vivien@planete-kraus.eu\n" -"POT-Creation-Date: 2021-05-10 14:42+0200\n" +"POT-Creation-Date: 2021-05-10 14:43+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" |