aboutsummaryrefslogtreecommitdiff
path: root/bin
Commit message (Collapse)AuthorAgeFilesLines
* More sentence case changesUlrich Müller2024-05-071-3/+3
| | | | | | Apparently these have been missed previously. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2024-01-191-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* *.xsl: XML declaration, local variables for Emacs, whitespace fixesUlrich Müller2023-11-021-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Force end tag for empty li elementsUlrich Müller2023-10-221-2/+2
| | | | | | | | | In order to make "tidy" happy. For some reason, xsltproc omits the end tag if the element is empty. Apparently, an empty comment is enough to make it think differently. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl, bin/gen-eclass-html.sh: Link to privacy policyUlrich Müller2023-10-051-2/+7
| | | | | Bug: https://bugs.gentoo.org/613938 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2023-01-211-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Don't show mailto linksUlrich Müller2022-04-261-0/+1
| | | | | | | | man2html's heuristic for recognition of e-mail addresses is unreliable, therefore drop them all. Reported-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2022-03-261-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* */*: consistent 'Portage' casingSam James2021-03-211-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Drop up arrow in navigation barUlrich Müller2021-02-251-1/+0
| | | | | | | This is redundant with breadcrumbs and doesn't exist anywhere else in the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2021-01-031-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Generate html for make.conf(5).Ulrich Müller2020-09-261-3/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Check for errors. Quote variables.Ulrich Müller2020-02-281-14/+16
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Use en-dash in page title.Ulrich Müller2020-02-281-1/+1
| | | | | | | | For consistency with devbook.xsl. The literal character is visually indistinguishable from other dashes when using a fixed-width font, therefore replace it by an &#x2013; escape. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: New option -n to create a placeholder file.Ulrich Müller2020-02-281-7/+43
| | | | | | | | | | The new strict dependencies will cause the build to fail if eclass-reference/text.xml is missing, because it is needed as a dependency for index.html of the previous and next documents. Add an option that makes it possible to create the file, even if the eclass documentation is missing. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Relative link to root page.Ulrich Müller2020-02-131-3/+9
| | | | | | | The absolute link was expanded to file:/// when testing locally. A relative link is also consistent with devbook.xsl output. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Move all header parts into the header element. Add main.Ulrich Müller2020-02-031-3/+4
| | | | | | This applies to bin/gen-eclass-html.sh as well. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Sync from devbook.xsl.Ulrich Müller2020-02-031-1/+1
| | | | | | Apply the "logo on mobile" patch to the eclass manpages, too. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Prevent removal of dirs.Ulrich Müller2020-01-291-0/+2
| | | | | | | | Updating a file doesn't change the modification time of its directory, therefore scanning for "old directories" produced false positives. Work around the problem by touching the directory. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Whitespace.Ulrich Müller2020-01-271-1/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Load devmanual.css stylesheet last.Ulrich Müller2020-01-221-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: More postprocessing for man2html.Ulrich Müller2020-01-181-0/+3
| | | | | | In order to silence the W3C Validator. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Don't include "Reference" in link texts.Ulrich Müller2020-01-161-1/+1
| | | | | | | This was redundant and inconsistent with the text generated by the XSL stylesheet. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: More man2html postprocessing.Ulrich Müller2020-01-121-1/+3
| | | | | | | | | | | | | Remove all links containing "${", because most likely these are instances of SRC_URI containing a variable reference. Remove <TT> since it is no longer valid in HTML5. man2html only outputs this pair of tags (with a sequence of non-breaking spaces inside) when it encounters a tab character in its input. Neither <code> nor any other logical markup would be a good replacement, so simply remove it. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update some external links.Ulrich Müller2020-01-091-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Remove broken links to localhost.Ulrich Müller2020-01-091-0/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/build_search_documents.py: <li/> is a terminal node, not intermediaryGöktürk Yüksek2020-01-021-2/+2
| | | | | | | Process <li/> as a terminal node. Reported-by: Ulrich Müller <ulm@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* Update copyright years.Ulrich Müller2020-01-021-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/build_search_documents.py: create search documents for <dl/>, <dd/>, <dt/>Göktürk Yüksek2019-12-261-2/+2
| | | | Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* bin/build_search_documents.py: handle multi-line indented text betterGöktürk Yüksek2019-12-251-3/+9
| | | | | | | | Beyond replacing newlines that show up in the middle of a text, remove the whitespace following the newline (which is the indentation) as well. Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* bin/build_search_documents.py: create documents from tablesGöktürk Yüksek2019-12-251-2/+2
| | | | Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* bin/build_search_documents.py: recurse down <ul/> and <li/>Göktürk Yüksek2019-12-251-1/+1
| | | | Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* bin/build_search_documents.py: do not use the deprecated .getchildren()Göktürk Yüksek2019-12-241-1/+1
| | | | | | | | | | ``` Deprecated since version 3.2, will be removed in version 3.9: Use list(elem) or iteration. ``` Suggested-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* bin/build_search_documents.py: fix aggressive whitespace strippingGöktürk Yüksek2019-12-211-4/+14
| | | | | | | | | | In stringify_node(), we aggressively strip the whitespaces around children nodes. This results in something like "<c>SLOT</c>, <c>:SLOT<c/>" being parsed as "SLOT,:SLOT", removing the white space between ',' and ':'. Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Rewrite the search functionality and extend the coverageGöktürk Yüksek2019-12-191-14/+98
| | | | | | | | | | | | | | | | | | | The current script only indexes the first <p> in a text.xml, and sometimes only partially if the text is interrupted by another tag such as <c/>. Modify build_search_documents.py such that: - It recursively traverses from chapter all the way down to subsubsection - Each <p>, <important>, <note>, <warning> is indexed separately - In the search results, the match entry will have the title in the form "Chapter[ -> Section[ -> Subsection[ -> Subsubsection]]]" Modify search.js such that: - The ref returned for a match is its index into "documents" array, which makes it possible to retrieve the document in O(1). Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* rename search_index.py to build_search_documents.py, and move it to bin/Göktürk Yüksek2019-12-191-0/+24
| | | | | | | | | | Executables go to bin/ Also, the name is misleading. The script does not build the search index, it builds the documents for the search engine to create the index. Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* devbook.xsl: Add html lang attribute.Ulrich Müller2019-12-161-1/+2
| | | | | | | The W3 Validator wants to have this. Also add a newline after the doctype declaration. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: More robust pattern matching.Ulrich Müller2019-12-151-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Fix regexp for link substitution.Ulrich Müller2019-12-151-9/+6
| | | | | | | | | | | | The previous regexp was too greedy and combined several links into one, if they were on the same line. Remove dead relative links (i.e., not pointing to other eclasses). Replace the complicated "tail" command by a simple "1,4d" in sed. This also makes the temporary file unnecessary. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Move header into a variable.Ulrich Müller2019-12-151-45/+47
| | | | | | | This is only for better readability of the actual code, and doesn't change functionality. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Eclasses are distributed under GPL-2.Ulrich Müller2019-12-141-1/+1
| | | | | | | Eclasses and the app-doc/eclass-manpage package are distributed under the GPL-2 (but not CC-BY-SA). Update license info in footer accordingly. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Fix category of eclass-manpages.Ulrich Müller2019-12-141-1/+1
| | | | | | The package has been moved to app-doc some time ago. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl, bin/gen-eclass-html.sh: Drop empty list item.Ulrich Müller2019-12-141-1/+0
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Support class="list-group" in <ul> element.Ulrich Müller2019-12-111-4/+4
| | | | | | | | | | | | | This replaces <list-group-d>, which was only used for the list of eclasses. Remove <list-group-u> which was unused. Update devbook.dtd and bin/gen-eclass-html.sh accordingly. Generated output in eclass-reference/index.html is identical as before, except for an (intentionally) removed empty line before the closing </div>. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Fix text.xml output.Ulrich Müller2019-12-081-1/+1
| | | | | | We need to generate XML suitable as xsltproc input, not HTML output. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Relicense the devmanual under CC-BY-SA-4.0.Ulrich Müller2019-11-291-1/+1
| | | | | Bug: https://bugs.gentoo.org/558732#c10 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Work for all common compression methodsBrian Evans2019-11-071-4/+19
| | | | Signed-off-by: Brian Evans <grknight@gentoo.org>
* bin/gen-eclass-html.sh: Fix BASENAME testBrian Evans2019-11-071-1/+1
| | | | Signed-off-by: Brian Evans <grknight@gentoo.org>
* gen-eclass-html.sh: Consider only manpages for HTML generation.Ulrich Müller2019-08-251-0/+1
| | | | | Closes: https://github.com/gentoo/devmanual.gentoo.org/pull/102 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright line in footer to "Gentoo Authors"Ulrich Müller2019-06-111-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>