Project_Documentation_Help_File.pdf

Thanks for purchasing! This document contains a how-to guide and

general information to help you get the most out of this product.

Look here irst for answers and to get started.

Project Documentation Help File

Project documentation help ile template designed for print or export to PDF. US Letter and A4 InDesign

templates. Character, paragraph and table styles setup for easy editing and font changes. Pages are auto

numbered, sections are auto numbered and the footer contains auto document title and document

modiication date. Contents page is auto generated based on the styles associated with sections you

wish to be indexed. In addition, table and character styles include formatting ActionScript for Flash

interactive projects which require documentation.

If you have any questions, feedback or suggestions regarding this product be sure to read the Help,

Support & Feedback section. Thank you for purchasing this product and I hope you ind it useful for your

projects.

~ Motionreactor

Project_Documentation_Help_File - August 10, 2009 4:54 PM

1. Overview

2. How-to

2.1 Edit Master Page Elements

2.1.1 Project Title / Header

2.1.2 Content Area

2.1.3 Page Numbers

2.1.4 Footer Document Title / Modiication Date

2.2 Create New Pages

2.3 Using Paragraph Styles

2.4 Working with the Table of Contents

2.4.1 Adding Sections

2.4.2 Updating

2.4.3 Styling Options

2.5 Special Formatting / Styling

2.5.1 Format ActionScript

2.6 Examining Document Structure

2.6.1 Show Hidden Characters

2.6.2 Show Text Threads

2.6.3 Show Frame Edges

3. Help, Support & Feedback

Contents

Project_Documentation_Help_File - August 10, 2009 4:54 PM

Overview

This document itself is an example of how to use the ‘Project Documentation Help File. The How-to

section illustrates the usage of formatting and styling features to make creating documentation for your

Flash projects as quick and easy as possible. Here is a breakdown of the features included.

Master Page

•

Project Title / Header

•

Content Area (Body text)

•

Footer; Auto Page Number, document title and modiication date

Paragraph Styles

•

Overall Font Choice

•

Indented paragraphs

•

Section headings

•

Contents (Styles for associating sections with the contents and styling the contents itself )

•

ActionScript styles (Format appearance of ActionScript)

Character Styles

•

URL Hyperlinks

•

Actionscript (Line numbers, keywords / identiiers, strings and comments)

Table Styles

•

Info box (Tips / notes / extra descriptions)

•

Directory / File paths

•

Images / Figures

•

ActionScript

Fonts

The font used in this template is Myriad Pro, (Included with Adobe Creative Suite) or available for

purchase at: http://www.linotype.com/1257/myriad-family.html

Page 1

Project_Documentation_Help_File - August 10, 2009 4:54 PM

How-to

This How-to contains information on the layout, styles and formatting available to make creating

documentation for your Flash projects as quick and easy as possible. If you examine the styling and

formatting applied to this document you can modify it or copy and apply it to another document or

read through the following sections to learn how to edit speciic elements.

2.1

Edit Master Page Elements

The master page “A-Master” is a template layout applied to all pages in the document. Individual

pages inherit the layout and elements contained within the master page. To make large changes to

the layout you must edit the master page. In the ‘Pages’ window (Menu > Window > Pages) double-

click the “A-Master” to begin editing.

2.1.1

Project Title / Header

Place your own text / vector or image in the area provided or change the layout altogether.

2.1.2

Content Area

It helps to enable ‘Show Frame Edges‘ (Menu > View > Show Frame Edges) so that you can see the

content area. Adjust the size, positioning and margins if you wish.

2.1.3

Page Numbers

The pages will auto number themselves, so you should not need to edit them other than to change

the styling. Adjust the styling of the page numbers, note that the master page number appears as

“Page A” where “A” is a special marker. You can re-insert this special marker (Menu > Type > Insert

Special Character > Markers > Current Page Number).

2.1.4

Footer Document Title / Modiication Date

The pages will automatically update when saved with the document title (ilename minus the

extension) and ile modiication date. Adjust the styling or layout if you wish. You can re-insert

the variable document title (Menu > Type > Text Variables > Insert Variable > File Name) or the

modiication date (Menu > Type > Text Variables > Insert Variable > Modiication Date).

Page 2

Project_Documentation_Help_File - August 10, 2009 4:54 PM

2.2

Create New Pages

Create a new page (Menu > Window > Pages). The new page will have inherited elements from the

‘A-Master’ page. You need to do two things to properly integrate the new page into the rest of the

document. Inherited master page elements are locked by default, so override the content area on the

new page (Ctrl+Shift (Windows) or Command+Shift (Mac OS) and click the text frame). You shoud

now be able to edit the content in the text frame.

The previous page content needs to be threaded to continue onto the new page. It will help to

enable ‘Show Text Threading’ (Menu > View > Show Text Threading) and ‘Show Frame Edges‘ (Menu >

View > Show Frame Edges). Select the text frame on the previous page and click the ‘out port’ (small

red triangle in the bottom right corner) and then click on the text frame of the new page to link the

content. Text from the previous pages will low onto the newly created page.

2.3

Using Paragraph Styles

Paragraph styles are applied to most of the elements throughout this document, so allow for great

control and lexibilty in styling the overall document. Style inheritance has been utilised so that

changes made on the “Basic Paragraph“ style are inherited by the styles in the “Base Styles” folder.

Other styles in the document then inherit from the “Base Styles”. For example, editing the ‘paragraph

rules’ of the “1st Level Heading” style will update the appearance of the “1st Level Heading Numbered“

style. Therefore the “1st Level Heading Numbered“ style is based on the “1st Level Heading“ style but

with the addition of section numbers and the relative link to the Table of Contents.

The inheritance of styling options is fairly logical, however if you need to examine where a particular

aspect of a style is set you need to double-click to edit the style in the ‘Paragraph Styles’ window

(Menu > Window > Type & Tables > Paragraph Styles). In the ‘General’ settings of the style you will

be able to see what it is ‘Based On’ and examine the text based ‘Style Settings’ to understand the style

inheritance.

Page 3

Project_Documentation_Help_File - August 10, 2009 4:54 PM

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika: