This package is TWL Manual Tools 3.4.
TWL Manual Tools is the name for the tools and libraries used to develop e-manuals for TWL game software. This document contains the release notes for TWL Manual Tools 3.4.
The following notes are relevant to this package.
There are differences in the types of non-breaking characters and some line wraps between version 3.0 and later of ManualEditor and versions earlier than 3.0.
For that reason, automatic line wrapping may differ depending on the horizontal width of text objects.
When using page files created on a version of ManualEditor earlier than 3.0 with a version of ManualEditor 3.0 or later, check whether there are any problems in line-wrap positions.
The current version of the E-Manual Display (M2d) library is not compatible with, and therefore cannot handle, e-manual binary files exported by versions of ManualEditor before version 2.0. Use binary data exported by the current version of ManualEditor.
The TWL Manual Tools package contains the following libraries and tools.
ManualPCPreviewCapturer, a support tool that uses the preview feature of ManualEditor to take screenshots using a computer
Extract the TWL Manual Tools package anywhere on the local disk. The TWL Manual Tools package is compressed in ZIP format, so use an appropriate unzip tool. A directory named TwlManualTools is created when the package is extracted.
To build the TWL Manual Tools libraries and demos, you must configure the environment variable TWLMANUALTOOLS_ROOT. Set this environment variable with the absolute path to the unzipped TwlManualTools directory.
Revisions up to the current version are noted here.
Information about TWL Manual Tools is located in the docs directory of the TWL Manual Tools source tree. Read the following documents first.
Quick Start.pdf)
This document explains how to set up TWL Manual Tools, run TWL ManualEditor, and build the E-Manual Display (M2d) library.
The manual for TWL ManualEditor.
The manual for TWL Manual Viewer SD.
Fundamentally, the TWL Manual Tools E-Manual Display (M2d) library is not designed to be thread-safe by supporting multithreading. For this reason, the library's functions may not always work correctly when called from an interrupt handler or a different thread.
The TWL Manual Tools E-Manual Display (M2d) library makes use of the divider. Consequently, if you use the M2d library without backing up and restoring the state of the divider as part of interrupt handling, calculation results before the interrupt may be destroyed.
To use the M2d library during interrupt handling, save and restore the state of the divider using the TWL-SDK functions CP_SaveContext and CP_RestoreContext.
Copyrights for the image data and music data used in the demo and sample programs included in this package are the property of Nintendo. This data may only be used in the demo and sample programs of this package, and may not be used in any other programs.
ManualPCPreviewCapturer uses the preview feature of ManualEditor to take screenshots automatically using a computer. The program is located in the TWL Manual Tools source tree, under tools/ManualPCPreviewCapturer. For information on how to use it, see the explanation shown in the ManualPCPreviewCapturer tool.
© 2007-2010 Nintendo No part of this document may be released, distributed, transmitted, or reproduced in any form or by any electronic or mechanical means, including information storage and retrieval systems, without permission in writing from Nintendo.
CONFIDENTIAL