[xml/sgml-commit] r2042 - in /packages/herold/trunk/debian: herold.1 herold.manpages herold.sh patches/ patches/jarsdir.patch patches/series rules source/ source/format
malat at users.alioth.debian.org
malat at users.alioth.debian.org
Wed Sep 19 14:19:13 UTC 2012
Author: malat
Date: Wed Sep 19 14:19:13 2012
New Revision: 2042
URL: http://svn.debian.org/wsvn/debian-xml-sgml/?sc=1&rev=2042
Log:
Cleanup package
Added:
packages/herold/trunk/debian/herold.1
packages/herold/trunk/debian/herold.manpages
packages/herold/trunk/debian/herold.sh (with props)
packages/herold/trunk/debian/patches/
packages/herold/trunk/debian/patches/jarsdir.patch
packages/herold/trunk/debian/patches/series
packages/herold/trunk/debian/source/
packages/herold/trunk/debian/source/format
Modified:
packages/herold/trunk/debian/rules
Added: packages/herold/trunk/debian/herold.1
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/herold.1?rev=2042&op=file
==============================================================================
--- packages/herold/trunk/debian/herold.1 (added)
+++ packages/herold/trunk/debian/herold.1 Wed Sep 19 14:19:13 2012
@@ -1,0 +1,222 @@
+'\" t
+.\" Title: herold
+.\" Author: Michael Fuchs
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 04/25/2012
+.\" Manual: User Commands
+.\" Source: herold
+.\" Language: English
+.\"
+.TH "HEROLD" "1" "04/25/2012" "herold" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+herold \- HTML to DocBook converter
+.SH "SYNOPSIS"
+.HP \w'\fBherold\fR\ 'u
+\fBherold\fR [OPTIONS]
+.SH "DESCRIPTION"
+.PP
+The reuse of HTML content in presentation\-neutral form is a frequent problem\&. One possible solution is to convert HTML to DocBook XML, because DocBook is a semantic markup language for documentation, which enables its users to create document content that captures the logical structure of the content\&. The command line tool
+herold
+can be used to convert HTML to DocBook\&. Because HTML elements are often used not as intended, the possibilities for such a transformation are somewhat limited\&. herold is part of the dbdoclet suite of tools\&. For more information visit
+\m[blue]\fBhttp://www\&.dbdoclet\&.org\fR\m[]\&.
+.SH "OPTIONS"
+.PP
+\-\-docbook\-add\-index, \-x
+.RS 4
+Automatically add an index element at the end of the document\&.
+.RE
+.PP
+\-\-docbook\-decompose\-tables, \-T
+.RS 4
+Decomposes the tables from the HTML code into single paragraphs\&. This can be useful, if a document contains a lot of tables for formatting reasons\&.
+.RE
+.PP
+\-\-docbook\-encoding, \-d
+.RS 4
+Specifies the encoding of the generated DocBook XML files\&.
+.RE
+.PP
+\-\-docbook\-root\-element, \-r
+.RS 4
+The root element of the document\&. Possible values are: book, article and reference\&. The default value for this option is \*(Aqarticle\*(Aq
+.RE
+.PP
+\-\-docbook\-title, \-t
+.RS 4
+The title for the resulting document\&.
+.RE
+.PP
+\-\-in, \-i
+.RS 4
+Specifies the HTML input file\&.
+.RE
+.PP
+\-\-help, \-h
+.RS 4
+Prints a help page on the console\&.
+.RE
+.PP
+\-\-html\-encoding, \-s
+.RS 4
+Specifies the encoding of the HTML source files, such as ISO\-8859\-1\&.
+.RE
+.PP
+\-\-out, \-o
+.RS 4
+Specifies the DocBook XML destination file\&.
+.RE
+.PP
+\-\-profile, \-p
+.RS 4
+A profile file with predefined settings\&.
+.RE
+.PP
+\-\-verbose, v
+.RS 4
+Enables the verbosity for the console output\&.
+.RE
+.PP
+\-\-version, \-V
+.RS 4
+Displays the version of herold\&.
+.RE
+.SH "CONFIGURATION"
+.PP
+The details of a transformation can controlled by a profile file\&. A profile offer more possibilities to influence the transformation than the command line arguments\&. The following example shows a typical profile\&.file\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+transformation html2docbook;
+
+
+input {
+}
+
+output {
+}
+
+section HTML {
+ encoding = "windows\-1252";
+ exclude = [ "//p[starts\-with(@class, \*(AqMsoToc\*(Aq)]", "" ];
+ section\-numbering\-pattern = "(((\ed\e\&.)+)?\ed?\e\&.?\ep{Z}*)\&.*";
+}
+
+section DocBook {
+ add\-index = true;
+ create\-xref\-label = false;
+ decompose\-tables = false;
+ document\-element = "book";
+ encoding = "UTF\-8";
+ image\-data\-formats = [ "gif", "base64" ];
+ title = "Tutorial";
+ use\-absolute\-image\-path = false;
+}
+.fi
+.if n \{\
+.RE
+.\}
+.SS "Syntax"
+.PP
+A profile file consists mainly of sections\&. Sections are used to group parameters which share the same context\&. Every section must start with the keyword
+\fIsection\fR
+followed by the name of the section\&. After the name comes the block of parameters, which is surrounded by curly braces\&. Parameters can be of type String, Number, Boolean or Array\&. Strings must be framed with double quotes, Arrays with square brackets\&. Inside an array, the elements must be comma separated\&. Every assignment must be finished by a semicolon\&. Multi line comments have the form
+\fI/* my comment */\fR
+, single line comments look like
+\fI// my comment\en\fR\&.
+.SS "Mandatory Elements"
+.PP
+A profile for herold must start with the line
+transformation html2docbook;\&. After this line the two mandatory sections,
+input
+and
+output, are following\&. These sections can be used to define fixed input and out files\&. Use the param file to define a path inside these sections, eg file = "\&./index\&.html";\&. Normally input and output files are set via command line arguments\&.
+.SS "Section HTML"
+.PP
+The section HTML defines parameters, which control the loading and parsing of the HTML input data\&..PP
+encoding
+.RS 4
+The character set used to read the input stream\&.
+.RE
+.PP
+exclude
+.RS 4
+Defines an array of xpath expressions\&. All matches are removed from the HTML DOM tree before transformation\&.
+.RE
+.PP
+section\-numbering\-pattern
+.RS 4
+Normally you want to get rid of the section numbering that comes with the HTML data, because it becomes part of the title text in DocBook\&. The section numbers will the appear twice in your target media\&. One from HTML and one from the DocBook XSL processing\&. The parameter section\-numbering\-pattern defines a regular expression, which is matched against the beginning of every section title\&. If it matches, this part is removed\&.
+.RE
+.SS "Section DocBook"
+.PP
+.PP
+add\-index
+.RS 4
+If set to true, an index element is inserted at the end of the DocBook XML\&.
+.RE
+.PP
+create\-xref\-label
+.RS 4
+if set to false, anchor elements doesn\*(Aqt get a xreflabel attribute\&.
+.RE
+.PP
+decompose\-tables
+.RS 4
+If set to true, tables structures will be ignored\&. The content of the table cells will be inserted into the DocBook XML as a sequence of paragraphs\&. This parameter can be useful if your HTML contains tables for formatting purposes\&. Normally you want to get rid of them, because they tamper the logical structure\&.
+.RE
+.PP
+document\-element
+.RS 4
+The document element you want to use\&. Must be one of article, book, part or reference\&.
+.RE
+.PP
+encoding
+.RS 4
+The character set which will be used for writing the output file\&.
+.RE
+.PP
+image\-data\-formats
+.RS 4
+An array of image formats\&. These formats will be inserted as imageobject elements, additionally to the format found in the src attribute of the corresponding img element\&. The original format is inserted twice with the roles "html" and "fo"\&. The other formats are inserted as "html\-<FORMAT>" and "fo\-<FORMAT>"\&.
+.RE
+.PP
+title
+.RS 4
+The title of the resulting document\&. If this parameter is undefined, herold tries to dected the title from the head section of the HTML data\&.
+.RE
+.PP
+use\-absolute\-image\-path
+.RS 4
+If you want absolute image paths in the fileref attribute of the imagedata element, set this parameter to true\&.
+.RE
+.SH "COPYRIGHT"
+.PP
+Copyright 2001\-2012 Michael Fuchs\&. License GPLv3+: GNU GPL version 3 or later
+\m[blue]\fBhttp://gnu\&.org/licenses/gpl\&.html\fR\m[]\&. This is free software: you are free to change and redistribute it\&. There is NO WARRANTY, to the extent permitted by law\&.
+.SH "AUTHOR"
+.PP
+\fBMichael Fuchs\fR
+.RS 4
+System Architect
+.RE
Added: packages/herold/trunk/debian/herold.manpages
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/herold.manpages?rev=2042&op=file
==============================================================================
--- packages/herold/trunk/debian/herold.manpages (added)
+++ packages/herold/trunk/debian/herold.manpages Wed Sep 19 14:19:13 2012
@@ -1,0 +1,1 @@
+debian/herold.1
Added: packages/herold/trunk/debian/herold.sh
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/herold.sh?rev=2042&op=file
==============================================================================
--- packages/herold/trunk/debian/herold.sh (added)
+++ packages/herold/trunk/debian/herold.sh Wed Sep 19 14:19:13 2012
@@ -1,0 +1,48 @@
+#!/bin/bash
+
+# Copyright (C) 2001-2008 Michael Fuchs
+trap cleanup 1 2 3 6
+
+cleanup() {
+ echo "Caught Signal ... cleaning up."
+ tput cnorm
+ exit 1
+}
+
+function fatal {
+ echo "[FATAL] $1"
+ exit 1
+}
+
+PROG=`type -p -- $0`
+
+if [ $? -ne 0 ] ; then
+ echo "Can't find installation directory!"
+ exit 1
+fi
+
+# echo "Program: $PROG"
+
+PROG=`readlink -f $PROG`
+# echo "Resolve symbolic links: $PROG"
+
+BIN_DIR=`dirname "$PROG"`
+# echo "bin directory: $BIN_DIR"
+
+HEROLD_HOME=`cd "$BIN_DIR/.." && pwd`
+# echo "herold home: $HEROLD_HOME"
+
+HEROLD_JAR=$HEROLD_HOME/jars/herold.jar
+[ -f $HEROLD_JAR ] || fatal "Can't find jar archive '$HEROLD_JAR'!"
+
+JAVA=`type -p -- java`
+[ $? -eq 0 ] || fatal "Can't find java!"
+
+lineWidth=`tput cols`
+if [ $lineWidth -lt 42 ]; then
+ lineWidth = 42;
+fi
+
+tput civis
+$JAVA -Ddesktop.session=$DESKTOP_SESSION -Dconsole.lineWidth=$lineWidth -jar $HEROLD_JAR "$@"
+tput cnorm
Propchange: packages/herold/trunk/debian/herold.sh
------------------------------------------------------------------------------
svn:executable = *
Added: packages/herold/trunk/debian/patches/jarsdir.patch
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/patches/jarsdir.patch?rev=2042&op=file
==============================================================================
--- packages/herold/trunk/debian/patches/jarsdir.patch (added)
+++ packages/herold/trunk/debian/patches/jarsdir.patch Wed Sep 19 14:19:13 2012
@@ -1,0 +1,53 @@
+Description: <short summary of the patch>
+ TODO: Put a short summary on the line above and replace this paragraph
+ with a longer explanation of this change. Complete the meta-information
+ with other relevant fields (see below for details). To make it easier, the
+ information below has been extracted from the changelog. Adjust it or drop
+ it.
+ .
+ herold (6.0.1-68-1) UNRELEASED; urgency=low
+ .
+ * Initial Debian Upload (Closes: #)
+ * Switch to dpkg-source 3.0 (quilt) format
+Author: Mathieu Malaterre <malat at debian.org>
+
+---
+The information above should follow the Patch Tagging Guidelines, please
+checkout http://dep.debian.net/deps/dep3/ to learn about the format. Here
+are templates for supplementary fields that you might want to add:
+
+Origin: <vendor|upstream|other>, <url of original patch>
+Bug: <url in upstream bugtracker>
+Bug-Debian: http://bugs.debian.org/<bugnumber>
+Bug-Ubuntu: https://launchpad.net/bugs/<bugnumber>
+Forwarded: <no|not-needed|url proving that it has been forwarded>
+Reviewed-By: <name and email of someone who approved the patch>
+Last-Update: <YYYY-MM-DD>
+
+--- herold-6.0.1-68.orig/build.xml
++++ herold-6.0.1-68/build.xml
+@@ -13,7 +13,7 @@
+ <include name="org/dbdoclet/trafo/tag/html/*" />
+ <include name="org/dbdoclet/trafo/html/docbook/editor/**" />
+ <classpath>
+- <fileset dir="../jars">
++ <fileset dir="jars">
+ <include name="*.jar" />
+ </fileset>
+ </classpath>
+@@ -23,7 +23,7 @@
+ <exclude name="**/*.java" />
+ </fileset>
+ </copy>
+- <jar destfile="../jars/herold.jar">
++ <jar destfile="jars/herold.jar">
+ <fileset dir="classes" />
+ <manifest>
+ <attribute name="Main-Class" value="org.dbdoclet.herold.Herold" />
+@@ -32,4 +32,4 @@
+ </manifest>
+ </jar>
+ </target>
+-</project>
+\ No newline at end of file
++</project>
Added: packages/herold/trunk/debian/patches/series
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/patches/series?rev=2042&op=file
==============================================================================
--- packages/herold/trunk/debian/patches/series (added)
+++ packages/herold/trunk/debian/patches/series Wed Sep 19 14:19:13 2012
@@ -1,0 +1,1 @@
+jarsdir.patch
Modified: packages/herold/trunk/debian/rules
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/rules?rev=2042&op=diff
==============================================================================
--- packages/herold/trunk/debian/rules (original)
+++ packages/herold/trunk/debian/rules Wed Sep 19 14:19:13 2012
@@ -14,5 +14,13 @@
# Target "clean" does not exist in the project "null".
override_dh_auto_clean:
+override_dh_clean:
+ find . -name *.class -delete
+ dh_clean jars/herold.jar
+
+override_dh_install:
+ dh_install debian/herold.sh usr/bin
+ mv debian/herold/usr/bin/herold.sh debian/herold/usr/bin/herold
+
get-orig-source:
uscan --verbose --force-download --rename --repack
Added: packages/herold/trunk/debian/source/format
URL: http://svn.debian.org/wsvn/debian-xml-sgml/packages/herold/trunk/debian/source/format?rev=2042&op=file
==============================================================================
--- packages/herold/trunk/debian/source/format (added)
+++ packages/herold/trunk/debian/source/format Wed Sep 19 14:19:13 2012
@@ -1,0 +1,1 @@
+3.0 (quilt)
More information about the debian-xml-sgml-commit
mailing list