doc/documentation: Move book "terminology" into new book "preface".
authorNils Gillmann <ng0@n0.is>
Mon, 14 May 2018 07:10:32 +0000 (07:10 +0000)
committerNils Gillmann <ng0@n0.is>
Mon, 14 May 2018 07:10:32 +0000 (07:10 +0000)
Signed-off-by: Nils Gillmann <ng0@n0.is>
doc/documentation/Makefile.am
doc/documentation/chapters/preface.texi [new file with mode: 0644]
doc/documentation/chapters/terminology.texi [deleted file]
doc/documentation/gnunet.texi

index 37c7fa9616e0b78906f0fd9e8101486035b7e303..0781b2fbb436e3b566b1f98d07f7eddae16ed401 100644 (file)
@@ -112,7 +112,7 @@ info_TEXINFOS =                                             \
 
 gnunet_TEXINFOS =                                              \
        chapters/developer.texi                                 \
-       chapters/terminology.texi                               \
+       chapters/preface.texi                           \
        chapters/installation.texi                              \
        chapters/philosophy.texi                                \
        chapters/user.texi                                      \
diff --git a/doc/documentation/chapters/preface.texi b/doc/documentation/chapters/preface.texi
new file mode 100644 (file)
index 0000000..b1fd14e
--- /dev/null
@@ -0,0 +1,64 @@
+@node Preface
+@chapter Prefacwe
+
+@c introductionary words here
+This collection of Manuals describes how to use GNUnet, a framework
+for secure peer-to-peer networking with the high-level goal to provide
+a strong foundation Free Software for a global, distributed network
+that provides security and privacy.  GNUnet in that sense aims to
+replace the current internet protocol stack.  Along with an
+application for secure publication of files, it has grown to include
+all kinds of basic applications for the foundation of a new internet.
+
+@menu
+* About this book
+* Introduction
+* General Terminology::
+* Typography::
+@end menu
+
+@node About this book
+@section About this book
+
+The books (described as ``book'' or ``books'' in the following) bundled as
+the ``GNUnet Reference Manual'' are based on the historic work of all
+contributors to GNUnet's Documentation. The Documentation existed in
+various formats before it came to be in the format you are currently
+reading. It is our hope that the content is described in a way that does
+not require any academic background, although some concepts will require
+further reading.
+
+Our (long-term) goal with these books is to keep them self-contained. If
+you see references to Wikipedia and other external sources (except for
+our academic papers) it means that we are working on a solution to
+describe the explanations found there which fits our usecase and licensing.
+
+The first chapter (``Preface'') as well as the the second
+chapter (``Philosophy'') give an introduction to GNUnet as a project,
+what GNUnet tries to achieve, 
+
+@node Introduction
+@section Introduction
+
+@c In less than 2 printed pages describe the history of GNUnet here,
+@c what we have now and what's still missing (could be split into
+@c subchapters).
+
+GNUnet in its current version is the result of almost 20 years of work
+from many contributors, with many publications.
+
+@node General Terminology
+@section General Terminology
+
+In the following Manual we may use words that can not be found in the
+Appendix. Since we want to keep the Manual selfcontained, we will
+explain words here.
+
+@node Typography
+@section Typography
+
+When giving examples for commands, shell prompts are used to show if the
+command should/can be issued as root, or if "normal" user privileges are
+sufficient. We use a @code{#} for root's shell prompt, a
+@code{%} for users' shell prompt, assuming they use the C-shell or tcsh
+and a @code{$} for bourne shell and derivatives.
diff --git a/doc/documentation/chapters/terminology.texi b/doc/documentation/chapters/terminology.texi
deleted file mode 100644 (file)
index 566a7b1..0000000
+++ /dev/null
@@ -1,23 +0,0 @@
-@node Terminology
-@chapter Terminology
-
-@menu
-* General Terminology::
-* Typography::
-@end menu
-
-@node General Terminology
-@section General Terminology
-
-In the following Manual we may use words that can not be found in the
-Appendix. Since we want to keep the Manual selfcontained, we will
-explain words here.
-
-@node Typography
-@section Typography
-
-When giving examples for commands, shell prompts are used to show if the
-command should/can be issued as root, or if "normal" user privileges are
-sufficient. We use a @code{#} for root's shell prompt, a
-@code{%} for users' shell prompt, assuming they use the C-shell or tcsh
-and a @code{$} for bourne shell and derivatives.
index 2cd72373b11797b377d867468a356f0f28b882f6..e914f11ba0d1ba3a0d2e6005d280d85e2e4c6c9e 100644 (file)
@@ -88,8 +88,10 @@ This document is the Reference Manual for GNUnet version @value{VERSION}.
 @detailmenu
  --- The Detailed Node Listing ---
 
-Terminology
+Preface
 
+* About this book
+* Introduction
 * General Terminology::
 * Typography::
 
@@ -111,12 +113,6 @@ Philosophy
 * Backup of Identities and Egos::
 * Revocation::
 
-@c Vocabulary
-@c 
-@c * Definitions abbreviations and acronyms::
-@c * Words and characters::
-@c * Technical Assumptions::
-
 GNUnet Installation Handbook
 
 * Dependencies::
@@ -196,7 +192,7 @@ GNUnet Developer Handbook
 @end menu
 
 @c *********************************************************************
-@include chapters/terminology.texi
+@include chapters/preface.texi
 @c *********************************************************************
 
 @c *********************************************************************