Opened 3 years ago

Last modified 2 years ago

#5350 new enhancement

Update User's Guide building

Reported by: Zimon Kuhs Owned by: jsten
Priority: major Milestone:
Component: Documentation Version: trunk
Keywords: Cc:

Description

A modular way of building the user's documentation would make it easier to make additions and also to specify what to include and not include. Also this would facilitate documentation for extensions.

A program that generates documentation based on the modules in Compiler would enable this. It then uses specification files in order to determine chapter ordering and which modules to include.

Change History (25)

comment:1 Changed 3 years ago by Zimon Kuhs

changeset:9838

  • Added a documentation builder program.
  • Moved User's Guide.
  • A description of how the program works exists in Compiler/Users Documentation Setup.txt

comment:2 Changed 3 years ago by Zimon Kuhs

changeset:9847

Updates to the documentation builder:

  • Fixed the makefile to not build anything documentation related.
  • The builder should now be able to handle chapter contents irrespective of source encoding.
  • Extended the builder to be able to replace any string with another.
  • Added the build-set.properties and chapter.order files to Compiler/UsersGuide (these were missing in r9838).
  • Fixed inclusions in JModelicaUsersGuide.xml.
  • Moved "sandbox" docbook files to their own folder.

comment:3 Changed 3 years ago by aramle

r9850 Updated UG.

comment:4 Changed 3 years ago by aramle

r9852 Updated UG.

comment:5 Changed 3 years ago by aramle

r9853 Updated UG.

comment:6 Changed 3 years ago by Zimon Kuhs

changeset:9854

Merged r9838, r9843, r9847, r9850 and r9852 to 2.0.x release branch. Ticket #5350 and #5353.

comment:7 Changed 3 years ago by Zimon Kuhs

changeset:9855

Updated limitations' chapter in UG.

comment:8 Changed 3 years ago by jsten

changeset:9856
Renamed JModelicaUsersGuide.xml to UsersGuide.xml.

This needs to be merged to trunk before closing this ticket

comment:9 Changed 3 years ago by Zimon Kuhs

changeset:9857

Fixed issue with swedish characters. Renamed JModelicaUsersGuide.xml UsersGuide.xml.

comment:10 Changed 3 years ago by aramle

r9860 Updated publication date for UG.

comment:11 Changed 3 years ago by Zimon Kuhs

changeset:9866

Reworked the structure of the Limitations' chapter in the user's guide: removed the top-level itemizedlist as XMLMind could not insert page breaks in the middle of a list.

comment:12 Changed 3 years ago by jakesson

changeset:9869:

Updated introduction of User's guide, see #5350.

comment:13 Changed 3 years ago by aramle

r9870 Updated UG.

comment:14 Changed 3 years ago by aramle

r9874 Updated ReleaseNotes

comment:15 Changed 3 years ago by Jonathan Kämpe

changeset:9875

Updated limitations (in branch)

comment:16 Changed 3 years ago by aramle

r9876 Updated Python package revisions.

comment:17 Changed 3 years ago by aramle

r9877 Updated Linux instructions with newer Ubuntu version.

comment:18 Changed 3 years ago by Jesper Mattsson

r9880

  • Some clarifications in Simulation and Limitations chapters of user's guide.
  • Fixed some issues with automatic generation of table of compiler options for user's guide.

Both these changes were made in the release branch only.

Last edited 3 years ago by Jesper Mattsson (previous) (diff)

comment:19 Changed 3 years ago by jakesson

changeset:9881
Updated release notes for 2.0, see #5350.

comment:20 Changed 3 years ago by jsten

changeset:9882
Merged revisions r9868-r9881 from trunk to release branch.

comment:21 Changed 3 years ago by jsten

changeset:9885
Merged revisions r9856, r9860, r9866, r9867, r9870, r9871, r9874-r9880 and 9882 from branches/2.0.x back to trunk.

comment:22 Changed 3 years ago by Zimon Kuhs

changeset:9889

Removed non-ASCII characters in the documentation builder file names.

comment:23 Changed 3 years ago by Zimon Kuhs

changeset:9890

Reverted r9889 as it was unnecessary.

comment:24 Changed 3 years ago by jsten

changeset:9892
Added instructions to always use UTF8 encoding when compiling compiler source files.

comment:25 Changed 2 years ago by aramle

r10315 Removed reference to removed chapter/section.

Note: See TracTickets for help on using tickets.