Opened 10 years ago

Closed 10 years ago

#19 closed enhancement (fixed)

documentation in version control

Reported by: prjemian Owned by: prjemian
Priority: major Version:
Keywords: Cc:

Description

The documentation on the wiki describes the current version. Previous versions must have documentation available and the wiki does not look like the best way to preserve that.

Perhaps a "Print page to PDF" capability can be added to the wiki.
Otherwise, the documentation should be moved to files maintained by version control and gathered/tagged by release version.

Change History (21)

comment:1 Changed 10 years ago by prjemian

  • Owner set to prjemian
  • Status changed from new to assigned

See changesets [90], [91], and [92] for progress. This is the important comment from changeset [91]: Start to convert documentation to DocBook?. Refs #19. This way, correct documentation can be kept with each revision of the standard.

Note, this comment still did not get attached to this TRAC ticket.

comment:2 Changed 10 years ago by prjemian

Moving ahead with the transition of documentation from mediawiki to DocBook?/v5.0.
There is a WWW tool (http://toolserver.org/~magnus/wiki2xml/w2x.php) to convert between these formats but it always requires some hand-editing. See changesets [91-103] for more details so far.

comment:3 Changed 10 years ago by prjemian

(In [116]) mroe graphics for the DocBook? documentation. Refs #19

comment:4 Changed 10 years ago by prjemian

(In [117]) add the case studies, reformat other things, refs #19

comment:5 Changed 10 years ago by prjemian

(In [118]) current PDF of manual, refs #19

comment:6 Changed 10 years ago by prjemian

(In [119]) table formatting, math typesetting, more content in the Preface and elements sections, refs #19

comment:7 Changed 10 years ago by prjemian

(In [120]) latest revision with all content committed. Still needs links connected and formatting ("" for example) but all content is now translated from wiki. Refs #19

comment:8 Changed 10 years ago by prjemian

(In [123]) more cross-references, refs #19

comment:9 Changed 10 years ago by prjemian

Alternatively, one can use
PDF Export to convert into PDF your MediaWiki? pages. The extension works with (requires) the open source htmldoc package.

comment:10 Changed 10 years ago by prjemian

(In [126]) prepare to move source files for documentation down one level. This should make it clearer how to find the manual. Refs #19

comment:11 Changed 10 years ago by prjemian

(In [127]) move source files for documentation down one level. This should make it clearer how to find the manual. Refs #19

comment:12 Changed 10 years ago by prjemian

(In [128]) more cross-references and formatting, first index entries, cleaned up the Makefile, refs #19

comment:13 Changed 10 years ago by prjemian

(In [129]) more cross-references, formatting, & indices, refs #19

comment:14 Changed 10 years ago by prjemian

(In [130]) more cross-references, formatting, & indices, refs #19

comment:15 Changed 10 years ago by prjemian

(In [131]) more cross-references, formatting, & indices, refs #19

comment:16 Changed 10 years ago by prjemian

(In [132]) make sure the canonical "cansas1d/1.0" is all lowercase in the documentation, refs #19

comment:17 Changed 10 years ago by prjemian

(In [134]) move the "elements" section, rename "definitions of terms" to "glossary," more cross-references, formatting, & indices, refs #19

comment:18 Changed 10 years ago by prjemian

(In [138]) more cross-references, formatting, & indices, refs #19

comment:19 Changed 10 years ago by prjemian

(In [140]) manual is nearly complete for v1.0 release, still a few problems to resolve (table+figure, code examples), refs #19

comment:20 Changed 10 years ago by prjemian

(In [141]) fresh build of PDF, rearranged and removed unnecessary sections, refs #19

comment:21 Changed 10 years ago by prjemian

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [142]) manual ready for review by 1dwg, equations still not converted properly but intent is readable, fixes #19

Note: See TracTickets for help on using tickets.