image

myManuals

Teach. Document. Demonstrate.

Made with myManuals


Table of contents

Welcome to myManuals!

myManual is made for creating all kinds of manuals. It's for teacher wishing to have more attractive teaching aids, trainer dreaming of interesting training manuals with screenshots and software developers writing gorgeous user manuals.

With myManuals you succeed in crafting attractive manuals and templates in no time. You are free to customize the design with CSS exactly to fit your needs or your corporate design. You can export each manual to a valid webpage, PDF, XML or RTFD.

The easy-to-use and precise preview supports you in customizing your manual for any export format. In addition you can reuse text and images quite easily within new manuals.

Getting started



« back to top


image
Short Introduction
Create a new manual in four easy steps:

1. Create new manual by pressing cmd+shift+N or use File > New Manual
2. Create new steps incl. header … footer by pressing cmd+N or use File > New Step
3. Preview a manual by pressing cmd+Y or the button in the toolbar
4. Export manual as a website or .pdf file by pressing cmd+shift+E or use File > Export Manual ..
image
Main view

New Manual



« back to top


image
Manual sheet (General view)
To create a new manual press cmd+shift+N or use File > New Manual.

Every manual typically consists of:

· Header image
· Title … Subtitle
· Header
· Step 1
· Step 2
· Step …
· Footer

You are free to choose for each manual which sections to use. This includes images and image's subtitles as well.
Every new manual uses at first the default template specified in the preferences. But by customizing the selected manual's template you are free to make it fit your needs. The customization will not affect the default template.


One hint: In case you don't specify a background color for a manual in the template you should use JPEG as the image format. In case your image has a different format myManuals will do the conversion into JPEG or PNG for you.

New Step



« back to top


image
Step window (Body view)
To create a new step press cmd+N or use File > New Step.
Typically each step includes:

· Header
· Image
· Body
· Footer

You are free to make use of the different sections to fit your needs. Of course you are free to add as many steps to each manual as needed and you can change the ordering of the steps as needed at any time.

It's best practice to set the font and font size in the template.
Formatting like:

· bold
· italic
· underline

can be set in the text itself.

One Hint: To add a Link use the "@"-button at the bottom or Format > Insert Link.

Image



« back to top


image
Insert an image by simply drag and drop it onto the image-view.

myManuals supports all image formats Mac OS X can handle.
Images are automatically downsized if needed and saved in the database.

When exporting your manual as a valid webpage you should set the image format in your manual settings (Edit Manual) to JPEG.
image
Hint
You can set the image size for export and printouts in the template. The size is either fixed (e.g. width:512 px;), relative (e.g. width: 60%;) or a maximum size is set (max-width: 724px;). You should set the maximum size of images in the preference of minimize the manual (and database) size. A maximum width of 800 px is absolutely enough for print outs on DIN A4 or US Letter; while 1000 px is good for print outs in landscape mode.

Annotations



« back to top


image
Annotation view
Often you need to mark a certain aspect in a screen shot or write some additional information (e.g. the shortcut) to a button or you need to highlight an important part in a construction drawing.

You can simply do this with the built-in annotation tools.
Click the 'Annotate…' button and select the desired tool.

Please notice that you can undo any step as long as the annotation-view is active…

Custom HTML



« back to top


image
You are free to include custom HTML objects in each manual and for each step.

This option may be used to include a 'banner' in the manual or a video in a step.

If you are going to publish the manual as a webpage on the internet you should link to an external hosted video.

If you are going to create a CD or DVD you can include the video by linking to a file with a relative path…

Preview



« back to top


image
Preview
Open the preview with cmd+Y or the button in the toolbar. Use the preview for a final check. Make changes to the template if needed.
image
Hint
Please keep in mind that there is no pagination in case you export to web. If you plan to export to PDF and the like - use the print-dialog (it displays your manual as a PDF) to check the pagination.

Export



« back to top


image
Export sheet
Once your manual is ready press cmd+shift+E and choose one of the following export formats:

· HTML (index. html | css folder | images folder)
· PDF
· RFTD
· WORD
· WEBARCHIVE
· XML
· PACKAGE (myManuals format for sharing editable manuals)

Preferences



« back to top


image
Preferences (General view)
General

AutoSave will be performed every 60 seconds.
Credit will show a small credit for myManuals.

Document settings will effect PDF export only.
Choose settings for margins, format and orientation.

Images sizes will effect saved images only.


CSS (Template)

This template will be used as default stylesheet for every new manual. Each manual can have its own stylesheet if needed (import a .css file or just overwrite the default one).


Defaults

If enabled the default settings will be applied for every new manual and step.
image
Hint
The freedom to design!
By intention myManual makes use of CSS.
It gives you maximum freedom to customize each template to fit your design needs.
myManual come with additional template files. You find them in the installation archiv (dmg file). Feel free to give them a try.
In case you need help with the template files please let me know. I am happy to help.

create.live.love
MOApp Software Manufactory is a state-of-the-art,
SME software architect headquartered in Mainz, Germany.

MOApp was brought to life by me, Michael Göbel. I have an unrelenting passion
for crafting small- scale things with a super sleek, minimalist design.

I believe that a software program should be as easy-to-handle as possible
and that it should always only focus on solving one job seamlessly.
In the process, the task at hand must be resolved as efficiently as possible and ideally,
users will not even need to pick up a manual to read the instructions …

MOApp Software is primarily tailored to private households,
freelancers, independent contractors and self-employed people.
Today, it provides more than twenty software products for highly diverse segments.
Not only do my programs receive top-notch ratings from MacUpdate and comparable sources,
but they are also continuously highly recommended by apple.com as a Staff Pick and Featured Download.