[DRE-commits] [ruby-hikidoc] 01/06: Use HikiDoc to properly render TextFormattingRules

Sat Aug 9 02:42:06 UTC 2014

This is an automated email from the git hooks/post-receive script.

cm-guest pushed a commit to branch master
in repository ruby-hikidoc.

commit 8ca6395630ab93c24c4280cad38992a7b6375e37
Author: Caitlin Matos <caitlin.matos at zoho.com>
Date:   Thu Aug 7 19:24:41 2014 -0400

    Use HikiDoc to properly render TextFormattingRules
    
    The file "TextFormattingRules" was previously being installed as-is.
    However, this document is meant to show examples of HikiDoc syntax, and
    therefore requires conversion to the HikiDoc format.
    
    The example syntax includes an image from an external source with an
    unknown licence. The file has been patched to instead use the included
    Debian logo, licensed under LGPL-3+.
    
    * convert TextFormattingRules to HTML with HikiDoc
    * new patch 02_textformattingrules to remove inclusion of unlicensed
      external image and instead use the Debian logo
    * create /usr/share/doc/ruby-hikidoc/html/
    * install docs to the new html subdirectory
    * register docs with doc-base
    * separate paragraph in d/copyright
---
 debian/copyright                      |  22 ++++++++++++++++++++++
 debian/local/debian-openlogo.png      | Bin 0 -> 1734 bytes
 debian/patches/02_textformattingrules |  22 ++++++++++++++++++++++
 debian/patches/series                 |   1 +
 debian/ruby-hikidoc.dirs              |   1 +
 debian/ruby-hikidoc.doc-base          |   7 +++++++
 debian/ruby-hikidoc.docs              |   3 +--
 debian/rules                          |  13 +++++++++++++
 debian/source/include-binaries        |   1 +
 9 files changed, 68 insertions(+), 2 deletions(-)

diff --git a/debian/copyright b/debian/copyright
index 9b9fe4e..a817e9f 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -18,6 +18,11 @@ Copyright: 2014 Caitlin Matos <caitlin.matos at zoho.com>
            2011 Youhei SASAKI <uwabami at gfd-dennou.org>
 License: BSD-3-clause
 
+Files: debian/local/debian-openlogo.png
+Copyright: 1999 Software in the Public Interest, Inc.
+License: LGPL-3.0+
+ Available at https://www.debian.org/logos/.
+
 License: BSD-3-clause
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
@@ -44,3 +49,20 @@ License: BSD-3-clause
  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License: LGPL-3.0+
+ This package is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 3 of the License, or (at your option) any later version.
+ .
+ This package is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ Lesser General Public License for more details.
+ .
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+ .
+ On Debian systems, the complete text of the GNU Lesser General
+ Public License can be found in "/usr/share/common-licenses/LGPL-3".
diff --git a/debian/local/debian-openlogo.png b/debian/local/debian-openlogo.png
new file mode 100644
index 0000000..ad91af7
Binary files /dev/null and b/debian/local/debian-openlogo.png differ
diff --git a/debian/patches/02_textformattingrules b/debian/patches/02_textformattingrules
new file mode 100644
index 0000000..e9599f0
--- /dev/null
+++ b/debian/patches/02_textformattingrules
@@ -0,0 +1,22 @@
+Description: replace external image with DFSG-compliant logo
+ The syntax reference for HikiDoc requires an image from an external site. The licence of this image is uncertain. The actual image used does not matter, as the document is demonstrating how to insert an image in HikiDoc syntax. To avoid licensing concerns and a potential privacy breach, I have replaced this external image with an included copy of the Debian logo.
+Author: Caitlin Matos <caitlin.matos at zoho.com> 
+Last-Update: 2014-08-07 
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+--- a/TextFormattingRules
++++ b/TextFormattingRules
+@@ -90,11 +90,11 @@ In this case, if the URL ends with jpg.,
+ 
+ *Example statement
+ 
+- http://jp.rubyist.net/theme/clover/clover_h1.png
++ https://www.debian.org/logos/openlogo-100.png
+ 
+ *Example output
+ 
+-http://jp.rubyist.net/theme/clover/clover_h1.png
++file:///usr/share/doc/ruby-hikidoc/html/debian-openlogo.png
+ 
+ !Preformatted text
+ 
diff --git a/debian/patches/series b/debian/patches/series
index dd42090..c9b9ad0 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
+02_textformattingrules
 01_correct_licence
diff --git a/debian/ruby-hikidoc.dirs b/debian/ruby-hikidoc.dirs
new file mode 100644
index 0000000..51c6687
--- /dev/null
+++ b/debian/ruby-hikidoc.dirs
@@ -0,0 +1 @@
+usr/share/doc/ruby-hikidoc/html
diff --git a/debian/ruby-hikidoc.doc-base b/debian/ruby-hikidoc.doc-base
new file mode 100644
index 0000000..3369d19
--- /dev/null
+++ b/debian/ruby-hikidoc.doc-base
@@ -0,0 +1,7 @@
+Document: ruby-hikidoc
+Title: HikiDoc syntax reference
+Section: Programming/Ruby
+
+Format: HTML
+Index: /usr/share/doc/ruby-hikidoc/html/TextFormattingRules.html
+Files: /usr/share/doc/ruby-hikidoc/html/TextFormattingRules.html
diff --git a/debian/ruby-hikidoc.docs b/debian/ruby-hikidoc.docs
index d3f2c15..655c842 100644
--- a/debian/ruby-hikidoc.docs
+++ b/debian/ruby-hikidoc.docs
@@ -2,5 +2,4 @@ README
 README.ja
 NEWS
 NEWS.ja
-TextFormattingRules 
-TextFormattingRules.ja 
+TextFormattingRules.ja
diff --git a/debian/rules b/debian/rules
index e01c781..c56e139 100755
--- a/debian/rules
+++ b/debian/rules
@@ -1,3 +1,16 @@
 #!/usr/bin/make -f
 %:
 	dh $@ --buildsystem=ruby --with ruby
+
+override_dh_installdocs:
+	# Need to use hikidoc to correctly format the TextFormattingRules page!
+	ruby -I lib/ bin/hikidoc ./TextFormattingRules >| TextFormattingRules.html
+
+	install -o root -g root -m 644 \
+	    ./TextFormattingRules.html \
+	    ./debian/ruby-hikidoc/usr/share/doc/ruby-hikidoc/html/TextFormattingRules.html
+	install -o root -g root -m 644 \
+	    ./debian/local/debian-openlogo.png \
+	    ./debian/ruby-hikidoc/usr/share/doc/ruby-hikidoc/html/debian-openlogo.png
+
+	dh_installdocs
diff --git a/debian/source/include-binaries b/debian/source/include-binaries
new file mode 100644
index 0000000..a87e016
--- /dev/null
+++ b/debian/source/include-binaries
@@ -0,0 +1 @@
+debian/local/debian-openlogo.png

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-hikidoc.git

