Convert documentation to AsciiDoc, delete translations.

This commit is contained in:
Lukas Fleischer 2011-02-24 11:36:50 +00:00
parent 2d938cdcda
commit 3e15efe917
12 changed files with 1172 additions and 8814 deletions

View File

@ -1,3 +1,13 @@
2011-02-12 Lukas Fleischer <calcurse@cryptocrack.de>
* doc/manual_en.txt: Convert English manual into AsciiDoc format.
* doc/*: Remove old documentation (switching to AsciiDoc).
* Makefile.am
* configure.ac
* doc/Makefile.am: Integrate AsciiDoc into the build process.
2011-01-14 Lukas Fleischer <calcurse@cryptocrack.de> 2011-01-14 Lukas Fleischer <calcurse@cryptocrack.de>
* src/help.c: Avoid a segfault when resizing the help window * src/help.c: Avoid a segfault when resizing the help window

View File

@ -1,21 +1,14 @@
# $calcurse: Makefile.am,v 1.7 2010/03/22 12:40:16 culot Exp $ # $calcurse: Makefile.am,v 1.8 2011/02/24 11:36:50 fleischer Exp $
AUTOMAKE_OPTIONS= foreign AUTOMAKE_OPTIONS= foreign
ACLOCAL_AMFLAGS = -I m4 ACLOCAL_AMFLAGS = -I m4
SUBDIRS = po src SUBDIRS = doc po src
man_MANS= src/calcurse.1 man_MANS= src/calcurse.1
EXTRA_DIST = \ EXTRA_DIST = \
$(man_MANS) \ $(man_MANS) \
INSTALL \ INSTALL \
ABOUT-NLS \ ABOUT-NLS
doc/manual.css \
doc/manual_en.html \
doc/manual_fr.html \
doc/manual_de.html \
doc/manual_es.html \
doc/manual_nl.html \
doc/manual_it.html

View File

@ -1,4 +1,4 @@
# $calcurse: configure.ac,v 1.36 2010/05/26 17:59:57 culot Exp $ # $calcurse: configure.ac,v 1.37 2011/02/24 11:36:50 fleischer Exp $
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# Init # Init
@ -68,6 +68,33 @@ AC_CHECK_HEADERS([math.h], [
AC_MSG_ERROR(The math library is required in order to build calcurse!)) AC_MSG_ERROR(The math library is required in order to build calcurse!))
], AC_MSG_ERROR(The math header is required in order to build calcurse!)) ], AC_MSG_ERROR(The math header is required in order to build calcurse!))
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# Check whether to build documentation
#-------------------------------------------------------------------------------
AC_ARG_WITH(asciidoc,
AS_HELP_STRING([--with-asciidoc],
[Use asciidoc to regenerate documentation.]),
[use_asciidoc=$withval],
[use_asciidoc="auto"])
if test x"$use_asciidoc" = x"auto"; then
AC_PATH_PROG([ASCIIDOC], [asciidoc])
if test -z "$ASCIIDOC"; then
have_asciidoc=no
AC_MSG_WARN([AsciiDoc not found - documentation will be skipped!])
else
have_asciidoc=yes
fi
elif test x"$use_asciidoc" = x"yes"; then
AC_PATH_PROG([ASCIIDOC], [asciidoc])
if test -z "$ASCIIDOC"; then
AC_MSG_ERROR([AsciiDoc not found and "--with-asciidoc" specified!])
fi
have_asciidoc=yes
elif test x"$use_asciidoc" = x"no"; then
AC_MSG_WARN(["--without-asciidoc" specified - documentation will be skipped!])
have_asciidoc=no
fi
AM_CONDITIONAL(HAVE_ASCIIDOC, test $have_asciidoc = yes)
#-------------------------------------------------------------------------------
# Compilation options # Compilation options
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
CFLAGS="$CFLAGS -Wall" CFLAGS="$CFLAGS -Wall"
@ -90,7 +117,7 @@ AM_CONDITIONAL(CALCURSE_MEMORY_DEBUG, test x$memdebug = xyes)
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# Create Makefiles # Create Makefiles
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
AC_OUTPUT(Makefile src/Makefile po/Makefile.in po/Makefile) AC_OUTPUT(Makefile doc/Makefile src/Makefile po/Makefile.in po/Makefile)
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# Summary # Summary
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------

18
doc/Makefile.am Normal file
View File

@ -0,0 +1,18 @@
# $calcurse: Makefile.am,v 1.1 2011/02/24 11:36:50 fleischer Exp $
AUTOMAKE_OPTIONS = foreign
ASCIIDOC_ARGS = \
-n \
-a toc \
-a icons
doc_DATA = \
manual.html
docdir = $(datadir)/doc/$(PACKAGE)
.txt.html:
if HAVE_ASCIIDOC
$(AM_V_GEN) $(ASCIIDOC) $(ASCIIDOC_ARGS) $<
endif

View File

@ -1,355 +0,0 @@
/* $calcurse: manual.css,v 1.5 2009/07/05 20:32:47 culot Exp $ */
/*
* Calcurse - text-based organizer
*
* Copyright (c) 2008 Frederic Culot <frederic@culot.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* 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.
*/
body {
margin: 0;
padding: 0;
padding-top: 10px;
text-align: center;
}
@media screen {
#mainContent{
width: 70%;
overflow: auto;
}
body {
overflow: auto;
background-color: #d3d3d3;
}
pre {
margin-left: 2.5cm;
margin-right: 2cm;
}
}
@media print {
#mainContent{
width: 90%;
overflow: visible;
}
body {
overflow: visible;
background-color: #ffffff;
}
pre {
margin-left: -1cm;
margin-right: 2cm;
}
}
#mainContent{
margin-right: auto;
margin-left: auto;
padding-left: 10px;
padding-right: 10px;
margin-bottom: 1em;
border: 1px solid gray;
text-align: left;
font-family: arial, helvetica, verdana, sans-serif;
font: 10px/12px cursive;
background-color: white;
}
#title {
text-align: center !important;
font: 24px/20px cursive !important;
}
div#mainContent h1 {
text-align: left;
padding: 0.5em;
padding-top: 1em;
font: 20px/16px cursive;
}
div#mainContent h2 {
margin-left: 1.5cm;
padding-top: 0.5em;
}
div#mainContent h2, h3 {
margin-bottom: 0;
padding-bottom: 0.3em;
}
div#mainContent h2 {
font: 14px/14px cursive;
}
div#mainContent h3 {
font: 12px/12px cursive;
}
p, blockquote {
text-align: justify;
text-indent: 1cm;
margin-top: 0;
}
h3, p, div.bib, ul, ol, dl, blockquote {
margin-left: 2.5cm;
margin-right: 2cm;
}
ul, ol, dl {
margin-top: 0;
margin-bottom: 1em;
}
dl.compact dt {
float: left;
}
dl.compact dd {
margin-bottom: 0.5em;
}
dd {
margin-bottom: 1em;
}
ul.sub, ol.sub, dl.sub {
margin-left: 0;
list-style: circle;
}
li {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
pre {
display: block;
border-left: 1px solid gray;
padding-left: 2em;
margin-right: 2cm;
}
code {
font-family: monospace;
font-weight: bold;
}
table {
border-style: solid;
border-collapse: collapse;
border-width: 1px;
}
div.tab {
padding: 1.5em;
margin-left: 4.5cm;
margin-right: 2cm;
}
img {
border-style: none;
}
div.img {
text-align: center;
}
tr, td, thead, tbody {
margin: 0;
}
thead {
background-color: gray;
color: black;
text-align: center;
}
td {
border-style: solid;
border-width: 1px;
}
span.main {
border-style: none;
border-bottom-style: dashed;
border-bottom-width: 1.5px;
padding: 0.2em;
}
#toc {
margin-top: 1.5cm;
margin-bottom: 1cm;
padding-top: 0;
padding-bottom: 0.2cm;
border-width: 0;
border-left-width: 1cm;
border-left-color: gray;
border-style: solid;
}
#toc h1 {
font: 12px/12px cursive;
}
#toc a {
text-decoration: none;
color: black;
}
a {
color: black;
}
#toc li {
list-style-type: none;
margin-top: 0;
margin-bottom: 0;
}
#toc ul ul li {
margin-top: 0;
margin-bottom: 0;
}
#toc ul ul ul li {
margin-left: -0.5cm;
}
#toc ul {
margin-top: 0;
margin-bottom: 0;
margin-left: 0;
padding-left: 1cm;
}
.todo {
color: green;
}
div.warn {
margin-top: 1cm;
margin-bottom: 1cm;
border-style: solid;
border-width: thin;
padding: 0.5em;
text-align: justify;
}
div.warn h1 {
display: inline;
padding: 0.5em;
margin: 0;
font: 8px/10px cursive;
}
div.res {
text-align: center;
}
span.res {
border-width: thin;
border-style: solid;
}
div.footer {
margin: 20px;
margin-left: 4%;
margin-top: 2cm;
border-width: 0;
border-style: solid;
border-top-width: medium;
font-style: italic;
text-align: right;
}
p.abstract {
margin-left: 3cm;
margin-right: 3cm;
}
.rq {
text-indent: 0;
font-style: italic;
border-style: solid;
border-width: medium;
border-left-width: 0;
border-top-width: 0;
border-color: gray;
padding: 0.4em;
}
dl .rq, ol .rq, ul .rq {
margin-left: 0;
margin-right: 0;
border: 0;
}
p.time {
text-indent: 0;
font-style: italic;
border-style: solid;
border-width: medium;
border-left-width: 0;
border-top-width: 0;
border-color: gray;
padding: 0.4em;
text-align: right;
}
p.qu {
font-style: italic;
text-align: left;
font: 8px/10px cursive;
border-width: 0;
border-left-width: thin;
border-left-color: gray;
border-style: double;
color: gray;
}
.valorise {
text-decoration: underline;
}
.big {
font-weight: bolder;
font: 12px/12px cursive;
}
.emp {
font-style: italic;
}
.tablesubtitle {
font-style: italic;
text-align: center;
}

1112
doc/manual.txt Normal file

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff