Added kstreamripper

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kstreamripper@1239912 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

2 files changed, 184 insertions, 0 deletions

diff --git a/doc/SConscript b/doc/SConscript
new file mode 100644
index 0000000..c16dbb0
--- /dev/null
+++ b/doc/SConscript
@@ -0,0 +1,83 @@
+#! /usr/bin/env python
+## This script demonstrates to build and install
+## the documentation of a kde program with scons
+##
+## Thomas Nagy, 2005
+
+## This file can be reused freely for any project (see COPYING)
+
+## First load the environment set in the top-level SConstruct file
+Import( 'env' )
+myenv=env.Copy()
+
+## The following looks complicated but it is not
+## We first define a function to install all files as documentation
+## The documentation is of course lying in subfolders from here
+## * normal files are installed under KDEDOC/destination
+## * meinproc files are not installed, but processed into a single 
+##   index.cache.bz2 which is installed afterwards
+
+## This is far more maintainable to have *one* file than
+## having lots of almost empty SConscript in several folders
+
+import os
+import sys
+import glob
+import SCons.Util
+
+## Define this to 1 if you are writing documentation else to 0 :)
+i_am_a_documentation_writer = 0
+
+## This function uses env imported above
+def processfolder(folder, lang, destination=""):
+	# folder is the folder to process
+	# lang is the language
+	# destination is the subdirectory in KDEDOC
+	
+	docfiles = glob.glob(folder+"/???*.*") # file files that are at least 4 chars wide :)
+
+	# warn about errors
+	#if len(lang) != 2:
+	#	print "error, lang must be a two-letter string, like 'en'"
+
+	# when the destination is not given, use the folder
+	if len(destination) == 0:
+		destination=folder
+	
+	docbook_list = []
+	for file in docfiles:
+
+		# do not process folders
+		if not os.path.isfile(file):
+			continue
+		# do not process the cache file
+		if file == 'index.cache.bz2':
+			continue
+		# ignore invalid files (TODO??)
+		if len( SCons.Util.splitext( file ) ) <= 1 :
+			continue
+
+		ext = SCons.Util.splitext( file )[1]
+		
+		# docbook files are processed by meinproc
+		if ext == '.docbook':
+			docbook_list.append( file )
+			continue
+
+		myenv.KDEinstall('KDEDOC', lang+'/'+destination, file)
+
+	# Now process the index.docbook files ..
+	if len(docbook_list) == 0:
+		return
+	if not os.path.isfile( folder+'index.docbook' ):
+		print "Error, index.docbook was not found in "+folder+'/index.docbook'
+		return
+	if i_am_a_documentation_writer:
+		for file in docbook_list:
+			myenv.Depends( folder+'index.cache.bz2', file )
+	myenv.Meinproc( folder+'/index.cache.bz2', folder+'/index.docbook' )
+	myenv.KDEinstall( 'KDEDOC', lang+'/'+destination, folder+'/index.cache.bz2' )
+
+## Use processfolder for each documentation directory
+processfolder('en/', 'en')
+
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
new file mode 100644
index 0000000..4826ffa
--- /dev/null
+++ b/doc/en/index.docbook
@@ -0,0 +1,101 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.0//EN" "dtd/kdex.dtd" [
+  <!ENTITY kappname "&KStreamRipper;">
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE" > <!-- change language only here -->   
+]>
+<!-- Important note: please use template.docbook instead of this file.
+     This is only the conversion of app.sgml into DocBook SGML.  
+     template.docbook gives you more information on what you can and
+     should do.  Thanks. --> 
+
+<book lang="&language;">
+
+  <bookinfo>
+    <title>The KStreamRipper Handbook</title>
+    <authorgroup>
+      <author>
+	<firstname></firstname>
+	<surname>Michael Goettsche</surname>
+	<affiliation><address><email>mail&#64;tuxipuxi&#46;de</email></address></affiliation>
+      </author>
+    </authorgroup>
+    <date>date</date>
+    <releaseinfo>0&#46;1</releaseinfo>
+    <abstract>
+      <para>SHORT DESCRIPTION GOES HERE</para>
+    </abstract>
+    <keywordset>
+      <keyword>KDE</keyword>
+      <keyword>KStreamRipper</keyword>
+    </keywordset>
+  </bookinfo>
+
+  <chapter id="introduction">
+    <title>Introduction</title>
+
+    <sect1 id="features">
+      <title>Features</title>
+      <para></para>
+    </sect1>
+  </chapter>
+
+  <chapter id="installation">
+    <title>Installation</title>
+
+    <sect1 id="how-to-obtain-KStreamRipper">
+      <title>How to obtain KStreamRipper</title>
+      <para></para>
+    </sect1>
+
+    <sect1 id="requirements">
+      <title>Requirements</title>
+      <para></para>
+    </sect1>
+
+    <sect1 id="compilation-and-installation">
+      <title>Compilation and Installation</title>
+
+      <para>Compiling KStreamRipper is very easy.  The following should do
+	it: <screen>
+<prompt>%</prompt> <userinput><command>./configure</command></userinput>
+<prompt>%</prompt> <userinput><command>make</command></userinput>
+<prompt>%</prompt> <userinput><command>make</command> install</userinput></screen>
+      </para>
+
+      <para>That should do it! Should you run into any problems,
+	please report them to the <ulink
+	url="mailto:mail&#64;tuxipuxi&#46;de">author</ulink></para>
+    </sect1>
+  </chapter>
+
+  <chapter id="using-KStreamRipper">
+    <title>Using KStreamRipper</title>
+    <para></para>
+  </chapter>
+
+  <chapter id="questionsanswersandtips">
+    <title>Questions, Answers, and Tips</title>
+
+    <qandaset id="faq">
+      <title>Frequently asked questions</title>
+      <qandaentry>
+	<question>
+	  <para>Question 1</para>
+	</question>
+	<answer>
+	  <para>The answer</para>
+	</answer>
+      </qandaentry>
+    </qandaset>
+
+  </chapter>
+</book>
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: t
+sgml-general-insert-case: lower
+End:
+-->