Commit 6f00b5ab authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Improve Scribo documentation.

	* doc/Doxyfile.in: Setup PATHs.

	* doc/images/comp2doc_structs.png,
	* doc/images/input_sauvola_bench.png,
	* doc/images/input_sauvola_sharpness.png,
	* doc/images/olena_mp00419c.png,
	* doc/images/olena_mp00419c_demat.png,
	* doc/images/olena_viewer1.png,
	* doc/images/output_k_0_03.png,
	* doc/images/output_k_0_34.png,
	* doc/images/output_k_0_50.png,
	* doc/images/output_k_0_60.png,
	* doc/images/output_sauvola.png,
	* doc/images/output_sauvola_ms.png,
	* doc/images/output_sauvola_ms_split.png,
	* doc/images/src/comp2doc_structs.svg: New.

	* doc/groups.dox,
	* doc/mainpage.dox,
	* doc/scribo/binarization/binarization.dox,
	* doc/scribo/binarization/niblack.dox,
	* doc/scribo/binarization/otsu.dox,
	* doc/scribo/binarization/sauvola.dox,
	* doc/scribo/core/datastructures.dox,
	* doc/scribo/debug/debug.dox,
	* doc/scribo/filter/component_groups.dox,
	* doc/scribo/filter/component_links.dox,
	* doc/scribo/filter/components.dox,
	* doc/scribo/filter/elements.dox,
	* doc/scribo/filter/filter.dox,
	* doc/scribo/filter/line_links.dox,
	* doc/scribo/filter/paragraphs.dox,
	* doc/scribo/routines.dox,
	* doc/scribo/toolchain/toolchain.dox,
	* scribo/binarization/sauvola.hh,
	* scribo/binarization/sauvola_ms.hh,
	* scribo/binarization/sauvola_ms_split.hh,
	* scribo/filter/objects_small.hh,
	* scribo/filter/objects_thin.hh,
	* scribo/table/internal/align_lines.hh,
	* scribo/table/internal/repair_lines.hh,
	* scribo/toolchain/content_in_doc.hh,
	* scribo/toolchain/content_in_hdoc.hh: Add documentation groups.
parent 67a55f1a
2012-02-27 Guillaume Lazzara <z@lrde.epita.fr>
Improve Scribo documentation.
* doc/Doxyfile.in: Setup PATHs.
* doc/images/comp2doc_structs.png,
* doc/images/input_sauvola_bench.png,
* doc/images/input_sauvola_sharpness.png,
* doc/images/olena_mp00419c.png,
* doc/images/olena_mp00419c_demat.png,
* doc/images/olena_viewer1.png,
* doc/images/output_k_0_03.png,
* doc/images/output_k_0_34.png,
* doc/images/output_k_0_50.png,
* doc/images/output_k_0_60.png,
* doc/images/output_sauvola.png,
* doc/images/output_sauvola_ms.png,
* doc/images/output_sauvola_ms_split.png,
* doc/images/src/comp2doc_structs.svg: New.
* doc/groups.dox,
* doc/mainpage.dox,
* doc/scribo/binarization/binarization.dox,
* doc/scribo/binarization/niblack.dox,
* doc/scribo/binarization/otsu.dox,
* doc/scribo/binarization/sauvola.dox,
* doc/scribo/core/datastructures.dox,
* doc/scribo/debug/debug.dox,
* doc/scribo/filter/component_groups.dox,
* doc/scribo/filter/component_links.dox,
* doc/scribo/filter/components.dox,
* doc/scribo/filter/elements.dox,
* doc/scribo/filter/filter.dox,
* doc/scribo/filter/line_links.dox,
* doc/scribo/filter/paragraphs.dox,
* doc/scribo/routines.dox,
* doc/scribo/toolchain/toolchain.dox,
* scribo/binarization/sauvola.hh,
* scribo/binarization/sauvola_ms.hh,
* scribo/binarization/sauvola_ms_split.hh,
* scribo/filter/objects_small.hh,
* scribo/filter/objects_thin.hh,
* scribo/table/internal/align_lines.hh,
* scribo/table/internal/repair_lines.hh,
* scribo/toolchain/content_in_doc.hh,
* scribo/toolchain/content_in_hdoc.hh: Add documentation groups.
2012-02-01 Guillaume Lazzara <z@lrde.epita.fr>
Fix and improve documentation in Scribo.
......
......@@ -112,18 +112,21 @@ EXCLUDE_SYMBOLS = *_ mln::trait::*
EXAMPLE_PATH = @top_srcdir@/scribo/doc/examples \
@top_srcdir@/scribo/doc/outputs \
@top_srcdir@/scribo/doc/examples/split \
@top_srcdir@/scribo/doc/outputs/split
@top_srcdir@/scribo/doc/outputs/split \
@top_srcdir@/scribo/src
EXAMPLE_PATTERNS = *.cc \
*.cc.raw \
*.txt
EXAMPLE_RECURSIVE = NO
IMAGE_PATH = @top_srcdir@/scribo/doc/img \
IMAGE_PATH = @top_srcdir@/scribo/doc/images \
@top_srcdir@/scribo/doc/figures
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
INPUT_ENCODING = ISO-8859-1
CITE_BIB_FILES = @top_srcdir@/doc/doc \
@top_srcdir@/doc/olena
LATEX_BIB_STYLE = plain
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
......
This diff is collapsed.
/*! \mainpage Documentation of Scribo
\section Introduction
Scribo, a framework for Document Image Analysis.
Its initial release has been developed in the context of the SCRIBO
project of the Free Software Thematic Group, part of the "Systematic
Paris-Région" Cluster (France). This project was partially funded by
the French government, its economic development agencies and by the
Paris-Région institutions.
It aims at providing the following features:
\li routines for DIA,
\li DIA toolchains,
\li text detection in document,
\li document layout analysis,
\li high-level data structures,
\li novel algorithms and techniques,
\li standard I/O,
\li graphical user interfaces,
\li and command Line Interfaces.
Its code is based on Milena, the generic and efficient c++ image
processing library of Olena.
It is integrated in the <a href="http://www.kde.org">KDE</a> semantic
desktop, <a href="http://nepomuk.kde.org">Nepomuk</a>, in the current
<a href="http://www.mandriva.com">Mandriva Linux</a> distribution.
\section Quickstart
No tutorial nor quick reference guide are written for now. But a good
start is to read the code of existing processing chain. You can take a
look at the following files :
\li \ref text_in_doc_preprocess.hh
\li \ref content_in_doc_functor.hh
\li \ref text_in_picture.hh
Take also a look at the <a href="modules.html">Modules section</a>.
<center>
<table border=0 cellpadding=5>
<tr>
<td>\image html olena_mp00419c.png "A document image."</td>
<td style="vertical-align:center;">\htmlonly<font size="300%">&rarr;&nbsp;</font>\endhtmlonly<td>
<td style="vertical-align:bottom;">\image html olena_viewer1.png "A GUI for analyzing the content and reconstruct the document."</td>
<td style="vertical-align:center;">\htmlonly<font size="300%">&rarr;&nbsp;</font>\endhtmlonly<td>
<td>\image html olena_mp00419c_demat.png "The reconstructed document in PDF."</td>
</tr>
</table>
</center>
\image latex olena_mp00419c.png
\image latex olena_viewer1.png
\image latex olena_mp00419c_demat.png
\section copyright Copyright and License
Copyright (C) 2011 EPITA Research and Development (LRDE)
This documentation is part of Olena.
Olena is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, version 2 of the License.
Olena 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 General Public License
for more details.
You should have received a copy of the GNU General Public License
along with Olena. If not, see <http://www.gnu.org/licenses/>.
*/
\ No newline at end of file
/*! \defgroup grpalgobin Binarization
*
* \brief Binarization algorithms.
*
* \ingroup grproutine
*/
/*! \defgroup grpalgobinniblack Niblack
*
* \brief Niblack's Binarization implementations.
*
* \ingroup grpalgobin
*/
/*! \defgroup grpalgobinotsu Otsu
*
* \brief Otsu's Binarization implementations.
*
* \ingroup grpalgobin
*/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment