Hello All,
Earlier today, Joe sent out a msg regarding a new documentation
structure. The following is a summary of recent changes.
Change Log:
Bare in mind, this whole project is very much a work in progress, with
changes happening daily.
** AsciiDoc is now part of the docs source tree and no longer requires
installation. The quick reference guide will be updated to reflect
this change. Additional guidance will be sent regarding OS specific
needs.
** To check out the latest revision:
svn co svn://svn.berlios.de/wsjt/branches/doc
** Building is the same as before:
/build-doc.sh [ option ]
OPTIONS: map65 simjt wsjt wsjtx wspr wsprx quick-ref dev-guide help
Using [ ./build-doc.sh help ] will pull up a simple list of available
builds, select a number and away it goes. ( legend says A-H, it has
been fixed. )
** The new structure is as follows:
./wsjt/
└── doc
├── asciidoc /* asciidoc.py, css & config files */
├── build-doc.sh /* top level build script */
├── functions /* setup and build script functions */
├── icons /* icons used across all docs */
├── map65
├── simjt
├── source /* non-application source files */
├── wsjt
├── wsjtx
├── wspr
└── wsprx
** Each application has it's own source directory with a file named:
<app-name>-main.adoc:
Example: ./wsjt/doc/map65/source/map65-main.adoc
** build-doc.sh currently builds TOC2 only (left side table
of contents). This will be upgraded in time to include no-TOC &
Top-TOC. WSJT-X is the only app with a populated main page. The
other apps have empty holding files for testing.
** The web-package function will re-added when all the TOC functions are
back in place.
The TO-DO list is long and distinguished. If your interested in
contributing to the docs projects, send a note to the devl-list or Joe,
as there is plenty to work on.
73's
Greg, KI7MT
[email protected]
_______________________________________________
Wsjt-devel mailing list
[email protected]
https://lists.berlios.de/mailman/listinfo/wsjt-devel
