| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2014 Frederik Heber. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file userguide.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Apr 18, 2014
|
|---|
| 12 | * Author: heber
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 | /**
|
|---|
| 16 | * \page userguide How to write the userguide
|
|---|
| 17 | *
|
|---|
| 18 | * The userguide is written with docbook. We have use XXE as means to write
|
|---|
| 19 | * the guide in a WYSIWYG style.
|
|---|
| 20 | *
|
|---|
| 21 | * In general, the guide
|
|---|
| 22 | * http://movementarian.org/docs/docbook-autotools/index.html
|
|---|
| 23 | * has been very helpful in setting docbook usage up with autotools. We
|
|---|
| 24 | * followed it closely with some minor modifications as we want to generate
|
|---|
| 25 | * a pdf instead of html.
|
|---|
| 26 | *
|
|---|
| 27 | * \section userguide-images How to get images working
|
|---|
| 28 | *
|
|---|
| 29 | * We have multiple screenshots to explain the graphical interface. These
|
|---|
| 30 | * reside in a distinct folder pictures. However, to get it working with
|
|---|
| 31 | * autotools we need to change some paths. And there we ran into a lot of
|
|---|
| 32 | * (newbie) trouble with docbook or rather with xsltproc, the preprocessor
|
|---|
| 33 | * for xml files in conjunction with xsl stylesheets.
|
|---|
| 34 | *
|
|---|
| 35 | * At one point we stumbled over catalogs that seem to be able to tell the
|
|---|
| 36 | * processor that he should look elsewhere for certain files but we could
|
|---|
| 37 | * get the processor to actually use these directives.
|
|---|
| 38 | *
|
|---|
| 39 | * Finally, we stumbled on some more and came onto this guide
|
|---|
| 40 | * http://www.sagehill.net/docbookxsl/GraphicsLocations.html
|
|---|
| 41 | * that finally explained what was the point with those images. So, we can
|
|---|
| 42 | * use either \a fileref, which might work if we set \a img.src.path, or we
|
|---|
| 43 | * have to define our images as entities in the very beginning of the xml
|
|---|
| 44 | * document and reference them via \a entityref with just the given token.
|
|---|
| 45 | * The latter then worked with the catalog as these are actually looked up,
|
|---|
| 46 | * i.e. here the URI mechanism does finally work. It does not work in the
|
|---|
| 47 | * case of fileref.
|
|---|
| 48 | *
|
|---|
| 49 | *
|
|---|
| 50 | * \date 2014-04-18
|
|---|
| 51 | *
|
|---|
| 52 | */
|
|---|
