public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: /
Date: Mon,  3 Feb 2020 00:07:43 +0000 (UTC)	[thread overview]
Message-ID: <1580688079.563f4c60d694a0ce2e053a88fdf11f1f88e63dcd.ulm@gentoo> (raw)

commit:     563f4c60d694a0ce2e053a88fdf11f1f88e63dcd
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Jan 28 19:40:51 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Mon Feb  3 00:01:19 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=563f4c60

Support offline browsing.

Pass an "offline" flag to devbook.xsl, which disables loading of
external assets and loads a simple CSS instead. This will replace
the fragile patching in the app-doc/devmanual ebuild.

offline.css was originally contributed (as fallback.css)
by Lucas Ramage in bug 617724.

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 Makefile    |  5 ++++-
 devbook.xsl | 55 +++++++++++++++++++++++++++++++++++++------------------
 offline.css | 19 +++++++++++++++++++
 3 files changed, 60 insertions(+), 19 deletions(-)

diff --git a/Makefile b/Makefile
index 3fb4c52..ef2c735 100644
--- a/Makefile
+++ b/Makefile
@@ -7,6 +7,9 @@ HTMLS := $(subst text.xml,index.html,$(XMLS))
 ECLASS_HTMLS := $(wildcard eclass-reference/*/index.html)
 IMAGES := $(patsubst %.svg,%.png,$(SVGS))
 
+# Nonzero value disables external assets for offline browsing.
+OFFLINE = 0
+
 all: prereq validate build documents.js
 
 prereq:
@@ -49,7 +52,7 @@ documents.js: bin/build_search_documents.py $(XMLS)
 #
 .SECONDEXPANSION:
 %.html: $$(dir $$@)text.xml devbook.xsl xsl/*.xsl $$(subst text.xml,index.html,$$(wildcard $$(dir $$@)*/text.xml))
-	xsltproc devbook.xsl $< > $@
+	xsltproc --param offline "$(OFFLINE)" devbook.xsl $< > $@
 
 validate: prereq
 	@xmllint --noout --dtdvalid devbook.dtd $(XMLS) \

diff --git a/devbook.xsl b/devbook.xsl
index 3ff6502..faf9796 100644
--- a/devbook.xsl
+++ b/devbook.xsl
@@ -14,6 +14,10 @@
 
 <xsl:output method="html" encoding="UTF-8" indent="yes" omit-xml-declaration="yes"/>
 
+<!-- When true, disable external assets for offline browsing.
+     The parameter can be passed with "xsltproc -\-param offline 1". -->
+<xsl:param name="offline" select="0"/>
+
 <xsl:variable name="newline">
 <xsl:text>
 </xsl:text>
@@ -451,13 +455,21 @@
       <title><xsl:value-of select="/guide/chapter[1]/title"/> – Gentoo Development Guide</title>
       <meta name="viewport" content="width=device-width, initial-scale=1.0" />
       <meta name="description" content="The Gentoo Devmanual is a technical manual which covers topics such as writing ebuilds and eclasses, and policies that developers should be abiding by." />
-      <link href="https://assets.gentoo.org/tyrian/bootstrap.min.css" rel="stylesheet" media="screen" />
-      <link href="https://assets.gentoo.org/tyrian/tyrian.min.css" rel="stylesheet" media="screen" />
+      <xsl:choose>
+        <xsl:when test="$offline">
+          <link rel="stylesheet" href="{$relative_path_depth_recursion}offline.css" type="text/css" />
+        </xsl:when>
+        <xsl:otherwise>
+          <link href="https://assets.gentoo.org/tyrian/bootstrap.min.css" rel="stylesheet" media="screen" />
+          <link href="https://assets.gentoo.org/tyrian/tyrian.min.css" rel="stylesheet" media="screen" />
+        </xsl:otherwise>
+      </xsl:choose>
       <link rel="stylesheet" href="{$relative_path_depth_recursion}devmanual.css" type="text/css" />
       <link rel="icon" href="https://www.gentoo.org/favicon.ico" type="image/x-icon" />
     </head>
     <body>
       <header>
+        <xsl:if test="not($offline)">
         <div class="site-title">
           <div class="container">
             <div class="row">
@@ -561,6 +573,7 @@
             </div>
           </div>
         </div>
+        </xsl:if>
         <div class="container">
           <div class="row">
             <div class="col-md010">
@@ -581,20 +594,24 @@
       </main>
       <footer>
         <div class="container">
-          <div class="row">
-            <div class="col-xs-12 col-md-offset-2 col-md-7">
-            </div>
-            <div class="col-xs-12 col-md-3">
-              <h3 class="footerhead">Questions or comments?</h3>
-              Please feel free to <a href="https://www.gentoo.org/inside-gentoo/contact/">contact us</a>.
+          <xsl:if test="not($offline)">
+            <div class="row">
+              <div class="col-xs-12 col-md-offset-2 col-md-7">
+              </div>
+              <div class="col-xs-12 col-md-3">
+                <h3 class="footerhead">Questions or comments?</h3>
+                Please feel free to <a href="https://www.gentoo.org/inside-gentoo/contact/">contact us</a>.
+              </div>
             </div>
-          </div>
+          </xsl:if>
           <div class="row">
             <div class="col-xs-2 col-sm-3 col-md-2">
-              <ul class="footerlinks three-icons">
-                <li><a href="https://twitter.com/gentoo" title="@Gentoo on Twitter"><span class="fa fa-twitter fa-fw"></span></a></li>
-                <li><a href="https://www.facebook.com/gentoo.org" title="Gentoo on Facebook"><span class="fa fa-facebook fa-fw"></span></a></li>
-              </ul>
+              <xsl:if test="not($offline)">
+                <ul class="footerlinks three-icons">
+                  <li><a href="https://twitter.com/gentoo" title="@Gentoo on Twitter"><span class="fa fa-twitter fa-fw"></span></a></li>
+                  <li><a href="https://www.facebook.com/gentoo.org" title="Gentoo on Facebook"><span class="fa fa-facebook fa-fw"></span></a></li>
+                </ul>
+              </xsl:if>
             </div>
             <div class="col-xs-10 col-sm-9 col-md-10">
               <strong>Copyright (C) 2001-2020 Gentoo Authors</strong><br />
@@ -608,11 +625,13 @@
           </div>
         </div>
       </footer>
-      <script src="https://assets.gentoo.org/tyrian/jquery.min.js"></script>
-      <script src="https://assets.gentoo.org/tyrian/bootstrap.min.js"></script>
-      <script src="https://assets.gentoo.org/lunr/lunr.min.js"></script>
-      <script><xsl:text>var documentsSrc = "</xsl:text><xsl:value-of select="$relative_path_depth_recursion"/><xsl:text>documents.js"</xsl:text></script>
-      <script src="{$relative_path_depth_recursion}search.js"></script>
+      <xsl:if test="not($offline)">
+        <script src="https://assets.gentoo.org/tyrian/jquery.min.js"></script>
+        <script src="https://assets.gentoo.org/tyrian/bootstrap.min.js"></script>
+        <script src="https://assets.gentoo.org/lunr/lunr.min.js"></script>
+        <script><xsl:text>var documentsSrc = "</xsl:text><xsl:value-of select="$relative_path_depth_recursion"/><xsl:text>documents.js"</xsl:text></script>
+        <script src="{$relative_path_depth_recursion}search.js"></script>
+      </xsl:if>
     </body>
     </html>
   </xsl:template>

diff --git a/offline.css b/offline.css
new file mode 100644
index 0000000..42f94e9
--- /dev/null
+++ b/offline.css
@@ -0,0 +1,19 @@
+body {
+    margin: 40px auto;
+    max-width: 650px;
+    line-height: 1.6;
+    font-size: 18px;
+    color: #454545;
+    background-color: #fafafa;
+    padding: 0 10px;
+}
+
+header, footer {
+    padding: 0.75em 1em;
+    margin: 0;
+    background-color: #e1e1e1;
+}
+
+h1, h2, h3, h4, h5, h6 {
+    line-height: 1.2;
+}


             reply	other threads:[~2020-02-03  0:07 UTC|newest]

Thread overview: 213+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-03  0:07 Ulrich Müller [this message]
  -- strict thread matches above, loose matches on Subject: below --
2024-11-12 18:51 [gentoo-commits] proj/devmanual:master commit in: / Ulrich Müller
2024-11-09  6:58 Ulrich Müller
2024-11-06 20:00 Ulrich Müller
2024-11-05 22:13 Ulrich Müller
2024-11-01 20:01 Ulrich Müller
2024-11-01 17:27 Ulrich Müller
2024-11-01 11:20 Ulrich Müller
2024-11-01 11:20 Ulrich Müller
2024-10-31 18:59 Ulrich Müller
2024-10-31 11:08 Ulrich Müller
2024-10-31 11:08 Ulrich Müller
2024-10-28 16:19 Ulrich Müller
2024-10-27  7:55 Ulrich Müller
2024-07-30 14:30 Ulrich Müller
2024-06-11 16:24 Ulrich Müller
2024-06-10 15:41 Ulrich Müller
2024-05-08  6:43 Ulrich Müller
2024-04-22 18:19 Ulrich Müller
2024-03-23  7:10 Ulrich Müller
2024-01-28 17:40 Ulrich Müller
2023-11-23 17:24 Ulrich Müller
2023-11-05 16:44 Ulrich Müller
2023-11-02 17:08 Ulrich Müller
2023-11-02 17:06 Ulrich Müller
2023-11-02 17:06 Ulrich Müller
2023-10-31 20:03 Ulrich Müller
2023-10-31 20:03 Ulrich Müller
2023-10-31 20:03 Ulrich Müller
2023-10-31 20:03 Ulrich Müller
2023-10-31 20:03 Ulrich Müller
2023-10-22 11:44 Ulrich Müller
2023-10-22 11:44 Ulrich Müller
2023-10-05 20:43 Ulrich Müller
2022-06-24 10:51 Ulrich Müller
2022-06-22 14:35 Ulrich Müller
2022-06-17  8:00 Ulrich Müller
2022-06-10 17:20 Ulrich Müller
2022-01-24 18:16 Ulrich Müller
2022-01-19 11:30 Ulrich Müller
2022-01-16 21:52 Ulrich Müller
2021-10-11 10:53 Ulrich Müller
2021-10-10 10:34 Ulrich Müller
2021-10-10 10:34 Ulrich Müller
2021-09-08 17:52 Ulrich Müller
2021-09-08 17:52 Ulrich Müller
2021-07-14 12:27 Ulrich Müller
2021-03-10 19:51 Ulrich Müller
2021-03-10 19:51 Ulrich Müller
2021-03-10 19:51 Ulrich Müller
2021-03-10 19:51 Ulrich Müller
2021-03-10 19:51 Ulrich Müller
2021-03-10 18:39 Ulrich Müller
2021-03-07 17:40 Ulrich Müller
2021-03-03 19:08 Ulrich Müller
2021-02-27 15:47 Ulrich Müller
2021-02-25 23:49 Ulrich Müller
2021-02-25 19:30 Ulrich Müller
2021-02-25 19:30 Ulrich Müller
2021-02-24 19:36 Ulrich Müller
2021-02-06 10:39 Ulrich Müller
2021-01-25 10:34 Ulrich Müller
2021-01-18 12:17 Ulrich Müller
2021-01-17 22:09 Ulrich Müller
2020-08-28 17:46 Ulrich Müller
2020-03-06 16:30 Ulrich Müller
2020-03-03  8:30 Ulrich Müller
2020-03-03  8:18 Ulrich Müller
2020-03-02 10:23 Ulrich Müller
2020-03-02 10:23 Ulrich Müller
2020-02-28  7:20 Ulrich Müller
2020-02-28  7:20 Ulrich Müller
2020-02-28  7:17 Ulrich Müller
2020-02-28  7:15 Ulrich Müller
2020-02-28  7:15 Ulrich Müller
2020-02-28  7:15 Ulrich Müller
2020-02-26 20:41 Ulrich Müller
2020-02-26 20:41 Ulrich Müller
2020-02-26 18:59 Ulrich Müller
2020-02-26 18:53 Ulrich Müller
2020-02-26 18:53 Ulrich Müller
2020-02-26 18:53 Ulrich Müller
2020-02-16 13:16 Ulrich Müller
2020-02-11 11:30 Ulrich Müller
2020-02-10 17:31 Ulrich Müller
2020-02-07 14:01 Ulrich Müller
2020-02-07  5:34 Ulrich Müller
2020-02-06 20:53 Ulrich Müller
2020-02-03 10:06 Ulrich Müller
2020-02-03  0:07 Ulrich Müller
2020-02-03  0:07 Ulrich Müller
2020-01-30 13:45 Brian Evans
2020-01-27 20:44 Ulrich Müller
2020-01-27 19:58 Ulrich Müller
2020-01-27 19:58 Ulrich Müller
2020-01-22 18:24 Ulrich Müller
2020-01-21 21:53 Ulrich Müller
2020-01-16 18:53 Ulrich Müller
2020-01-15  7:06 Ulrich Müller
2020-01-14  8:15 Ulrich Müller
2020-01-12  9:23 Ulrich Müller
2020-01-09  7:34 Ulrich Müller
2020-01-09  7:34 Ulrich Müller
2020-01-02 13:38 Ulrich Müller
2020-01-02 12:54 Ulrich Müller
2020-01-02 12:54 Ulrich Müller
2020-01-02 12:54 Ulrich Müller
2019-12-26 21:36 Ulrich Müller
2019-12-26 20:33 Ulrich Müller
2019-12-26 17:06 Ulrich Müller
2019-12-26 16:47 Ulrich Müller
2019-12-21  5:19 Ulrich Müller
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-19 21:02 Göktürk Yüksek
2019-12-14 10:46 Ulrich Müller
2019-12-10  8:47 Ulrich Müller
2019-12-10  8:47 Ulrich Müller
2019-12-07 22:05 Ulrich Müller
2019-11-26  3:05 Göktürk Yüksek
2019-03-22 18:51 Brian Evans
2019-03-22 18:51 Brian Evans
2019-03-19 19:02 Brian Evans
2019-03-19 17:11 Brian Evans
2018-01-03  5:57 [gentoo-commits] proj/devmanual:codesample-indent-fix " Göktürk Yüksek
2018-01-03 21:59 ` [gentoo-commits] proj/devmanual:master " Göktürk Yüksek
2017-02-05 22:41 Ulrich Müller
2016-10-31  1:21 Göktürk Yüksek
2016-10-28 17:15 Ulrich Müller
2016-10-06 22:09 Mike Gilbert
2016-06-15 18:46 Ulrich Müller
2016-05-15 11:48 Ulrich Müller
2016-05-15 11:48 Ulrich Müller
2016-04-02  8:54 Ulrich Müller
2016-02-05  8:41 Ulrich Müller
2016-01-01 21:59 NP Hardass
2015-09-05 15:48 Markos Chandras
2015-08-27  6:50 Justin Lecher
2015-08-21  6:36 Justin Lecher
2015-08-21  6:36 Justin Lecher
2015-08-20  7:06 Justin Lecher
2015-08-20  7:04 Justin Lecher
2015-08-18 11:47 Justin Lecher
2015-08-09 12:39 Justin Lecher
2015-08-09 12:39 Justin Lecher
2015-08-09  9:30 Justin Lecher
2015-08-09  9:30 Justin Lecher
2015-07-22  1:15 Jorge Manuel B. S. Vicetto
2015-06-17 12:05 Ulrich Müller
2015-06-01 18:41 Ulrich Müller
2015-06-01 15:38 Ulrich Müller
2015-05-31 10:45 Markus Meier
2015-05-31 10:45 Markus Meier
2015-03-30 18:21 Markos Chandras
2015-03-11 18:26 Markos Chandras
2015-02-15  9:54 Markos Chandras
2015-01-17  9:07 Markos Chandras
2014-11-14 18:07 Markos Chandras
2014-11-14 18:07 Markos Chandras
2014-11-14 18:07 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-11-08 12:27 Markos Chandras
2014-10-18 17:36 Markos Chandras
2014-10-18 17:36 Markos Chandras
2014-10-18 17:36 Markos Chandras
2014-10-18 17:35 Markos Chandras
2014-07-24 18:06 ` Markos Chandras
2014-10-18 17:35 Markos Chandras
2014-07-24 18:06 ` Markos Chandras
2014-10-18 17:35 Markos Chandras
2014-07-24 18:06 ` Markos Chandras
2014-07-24 18:06 Markos Chandras
2014-10-18 17:35 ` Markos Chandras
2014-03-16 10:24 Markos Chandras
2014-03-16 10:24 Markos Chandras
2014-03-16 10:24 Markos Chandras
2014-03-08 14:53 Markos Chandras
2014-01-05 12:35 Markos Chandras
2014-01-04 11:23 Markos Chandras
2014-01-03 18:32 Markos Chandras
2013-09-26  7:41 Markos Chandras
2013-09-21 12:23 Markos Chandras
2013-09-21 12:23 Markos Chandras
2013-07-25  8:28 Justin Lecher
2013-05-19  8:38 Markos Chandras
2013-05-15 12:57 Dirkjan Ochtman
2013-05-12 19:25 Markos Chandras
2013-05-12 15:06 Markos Chandras
2013-05-11 19:02 Markos Chandras
2012-10-12 17:44 Ulrich Mueller
2012-08-08 19:23 Markos Chandras
2012-03-18  0:16 Markos Chandras
2011-12-20 12:39 Torsten Veller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1580688079.563f4c60d694a0ce2e053a88fdf11f1f88e63dcd.ulm@gentoo \
    --to=ulm@gentoo.org \
    --cc=gentoo-commits@lists.gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox