Technical Design Document (TDD) User s Guide

Transcription

1 Technical Design Document (TDD) User s Guide May 9, :53 PM

2 Contents The Technical Design Document (TDD) Overview 3 Master Pages 3 Design Pages 5 Styles 5 Importing the IMDP 7 Create the IMDP Excerpt 7 Convert excerpt to RTF using Adobe InDesign 8 Placing the IMDP excerpt into the TDD 9 Building the TDD 10 Adding Storyboard Panel pages 10 Export the Narrative Script 12 Updating the Narrative Script 13 Placing Artwork 14 Page 2

3 The Technical Design Document (TDD) Overview There are two templates for the TDD based on the development environment TDD_template.indt and TDD_template_html5.indt. TDD_template.indt is based upon the Flash/XML ContentLoader development environment with the dimensions of 950x562. The TDD_template_html5.indt is based upon the HTML5 development environment with the dimesions of 1920x1080. Each TDD contains specific Master pages and Character, Paragraph and Object styles which used to properly format the document. Additional Project Character, Paragraph and Object styles may be created for representation of designed content. Master Pages [None]: A general blank page used for the Style Guide and storyboarding elements. 0-IMDP: Styled to contain the storyboard s Main Number which is replicated on subsequent slides. Used for placement of the IMDP excerpt. 1-One Panel: Single panel page styled for the Flash content loader size (950x562) containing sections for narration and description. Used when LESS description and element movement is needed (e.g. title slides, still slides, one element moves, etc.). 2-Two Panel: Two-paneled pages styled for the Flash content loader size (950x562) containing sections for narration and description. Used most commonly for general detail description and element movement understanding. 4-Four Panel: Paneled pages styled for the Flash content loader size (950x562) containing a section for narration with no description. Used when MORE detailed complex description and movement is required and needs to be shown for developmental clarity. 6-Six Panel: Paneled pages styled for the Flash content loader size (950x562) containing a section for narration with no description. Used when MORE detailed complex description and movement is required and needs to be shown for developmental clarity. Page 3

4 Initial edited Module/Video Title Initial edited Storyboard Number Placed Lesson Title and IMDP content Style Guide Page IMDP Page Callouts to use for description Running Storyboard Number Running Module/Video Title Running Lesson Title Storyboard Pages Description text Narrative text Image Grid for Graphic placemnent Edited Panel Number Storyboard Pages Page 4

5 Design Pages Page 1: This page is reserved for the Style Guide describing color scheme, specific design choices and elements used throughout the project. Callout symbols for storyboard description are here for refenece to assist developers. This page uses the [None] master page. Enter the title of the project at the top of the page in the designated area to have the title continue to subsequent pages of the TDD. Page 2: This page is reserved for placement of the IMDP excerpt which creates subsequent pages upon proper placement. It uses the 0-IMDP master page. After initial placement of the IMDP excerpt the Master page should be overridden in order to edit the Storyboard number for each IMDP section. Page 3 Page <#>: Subsequent IMDP and inserted paneled storyboards. Styles The TDD has many styles to format the document to include designer created Project styles. The Storyboard paragraph styles are created with specific properties that affect textual flow from text frame to text frame. The Project Styles folders for each style may be used to create project specific elements not created and imported from an external graphics application. Character Styles The Storyboard character styles can be used for emphasizing key words of Narration, Description or actions shown. Normal plus Heading 3 and Heading 4 control the IMDP import. Normal Highlight gives even more emphasis with a color change as well as bold. Action Bold is used in the Storyboard Designator arrows to emphasize key words for the developer. Paragraph Styles These style drive all of the textual elements in the TDD. Most of these styles are self explanatory but some are extremely specifc in their function. Normal plus Heading 3 and Heading 4 control the IMDP import. Storyboard Number handles the storyboard number on the IMDP page and subsequent storyboard pages. Panel Number does what it implies. It styles the numbers associated with each individual storyboard panel. Narration Number is the header within the Narration text frame. When applied it jumps the flowing text into the next text frame. It s followed by Narration Body for the dialog. Page 5

6 Desciption Body is similar to Narration Body but a different color for distinction and is bulleted with a carat (>). Title handles the main title of the module or video and flows across all subsequent storyboard pages. Lesson Title handles each IMDP section/lesson title and flows across all subsequent storyboard panel pages. Label handles the formatting of all the area labels on the storyboard pages. Object Styles The object styles control the page layout as well as the formatting characteristics for the text frames themselves. The text box style controls the size, stroke, padding and colors used to form the text frame. Ditto for the Panel Number. Two Column Layout formats the IMDP pages when placed to better flow the amount of information. Arrows (filled) and Arrows (line) format the Storyboard Designators. This way all of the designators can be changed at once in order to segregate them from the Project s color scheme. Page 6

7 Importing the IMDP Upon approval of the IMDP the Technical Designer must prepare the document for import into the Technical Design Document (TDD) generated in Adobe InDesign. Create the IMDP Excerpt Upon approval of the IMDP the Technical Designer must prepare the document for import into the Technical Design Document (TDD) generated in Adobe InDesignProject brief and brainstorming. 1. Open the IMDP in Word. 2. Delete all sections except Section 2.3 Lesson and Topic Structure. Delete the section number and title as well as the Provide the following... sentence. Only the outline is needed. 3. Save the file appending _excerpt to the filename (e.g. Project_IMDP_excerpt.docx) 4. Now, ensure the outline is properly formatted for importing into the Adobe InDesign Technical Design Document template. a. Lesson Titles are Heading 3 b. Sections are Heading 4 c. Body text is Normal d. Insert Page Breaks between Lesson Titles Delete these lines Heading 3 Heading 4 Normal Insert a page break Page 7

8 Convert excerpt to RTF using Adobe InDesign Converting the excerpt eases mapping of Word styles to InDesign styles during placement in the TDD. 1. Open Adobe InDesign to create a new document of any size... you re not going to save this, it s just temporary. 2. In the new document, select File > WordsFlow > Place without WordsFlow 3. In the Place dialog box, select the Word file, check the show Import Options box and click the Open button. 4. In the Microsoft Word Import Options dialog box, choose the Preserve Styles and Formatting radio button, as well as Import Styles Automatically. Yes, you do want to import all the Word styles into this layout. For now. 5. Click the loaded Place cursor anywhere on your new document so it creates one text frame with some of the text in it. Don t worry if it s overset. Note all the disc icons infesting your Paragraph Styles and Character Styles palettes. Not to worry. 6. Double-click inside the text frame so you get the Type tool cursor blinking in it, and choose File > Export. You re going to export this entire story to a new file. 7. In the Export dialog box, choose Rich Text Formatting from the Format dropdown menu, and save and name the.rtf file appropriately in the project folder. Rich Text Formatting retains virtually all of the Word formatting, including Style names, but only those actually used in the file. 6. Close the temporary InDesign document not saving changes. You don t need it anymore. Page 8

9 Placing the IMDP excerpt into the TDD Place the exported RTF document you just created. The Custom Style Mapping dialog box should have a much shorter list of styles to map, indicating just the ones that were actually used in the original Word file. 1. Open the Technical Design Document template in InDesign (TDD_template.indt) which creates an Untitled-1.indd file. Save the file with the appropriate filename for the project (e.g. ProjectName_TDD.indd). 2. Within the newly saved TDD, go to Page 2, which uses the IMDP master page. Page 1 is reserved for the Style Guide. 3. File > WordsFlow > Place without WordsFlow the IMDP RTF file. 4. In the Place dialog box, select the RTF file, check Show Import Options and click Open. 5. In the RTF Import Options dialog box, select IMDP RTF import from the Preset dropdown. Ensure Preserve Styles and Formatting and Customize Style Import radio buttons are selected (See image). Click OK. This will load the cursor with text. Wait! Don t click the page, yet! 6. From the Layers panel, ensure you are on the IMDP layer (pink) and it s unlocked. 7. From the Object Styles panel, ensure that Two Column Layout is selected. 8. Now, hover your cursor over the upper left corner margin on Page 2 and while holding the [Shift] key, click the corner (Holding shift will create individual pages IMDP pages based on the page breaks previously created in the RTF file). 9. From the Pages panel, select ALL of the newly created IMDP pages. Right-click and select Override All Master Page Items (Ctrl+Alt+Shift+L). This will make the Storyboard Numbers editable. Go to each IMDP page and change the storyboard number 000 to a sequential number beginning at 010 (e.g. 010, 020, 030, etc.) IMPORTANT: If the styles do not place correctly from the RTF file perform the following to correct all the formatting overrides: 1. Click inside the first text frame to get a text cursor. 2. Select all of the text in the document (ctrl-a). 3. In the Character Styles panel, select the [None] style. 4. In the Paragraph Styles panel, at the bottom next to the folder button, ctrl-click the Clear overrides in Selection button. This should correct all the formatting in the document. Page 9

10 Building the TDD Adding Storyboard Panel pages Once the IMDP excerpt is placed correctly and numbered paneled storyboards may be added in between the IMDP sections. 1. In the Pages panel, select the IMDP page to which you want to add a storyboard. 2. Right-click and select Insert Pages 3. In the Insert Pages dialog box, set Pages: to number of storyboards you want. Set Insert: to After Page and the page to insert them after (e.g. After Page, 2). Finally, set Master: to which paneled storyboard you want (e.g Single, Quad, etc). The newly created storyboard panel pages should reflect the associated IMDP storyboard number at the upper right. 4. Back in the Pages panel, select the all newly created storyboard panel pages, right-click and select Override All Master Page Items (Ctrl+Alt+Shift+L). This will make the page elements editable (e.g. Panel number, Narration, and Description text frames). 5. Change each panel number from 00 to a sequential number for all of the new panels on each new page (e.g. 01, 02, 03, etc). 6. Link the Narration text frame from the each storyboard panel page to the Narration text frame on the next page. You must link all Narration text frames for ALL storyboard panel pages to include crossing IMDP storyboard pages. Click the square just above the bottom right corner of the text frame. This should load your cursor with text. Now, click inside the next text frame to link them. A line should appear between the text frames depicting their connection. Linking the text frames creates a continuous narrative script to used in the recording booth. Page 10

11 Click here to load the cursor Click inside the text frame to link/ flow the narrative Page 11

12 Export the Narrative Script After linking all of the Narration text frames within the TDD it s time to export the narrative script using the WordsFlow plugin for Adobe InDesign. This creates a fully dynamic Word document outside of InDesign that can be updated real-time from either Word or InDesign. This is key to maintaining the integrity of the narrative script prior to recording as well as for the transcript and closed captioning. 1. In the TDD on a storyboard panel page, select a Narration text frame. Right-click > WordsFlow > Export with WordsFlow 2. Save the document in the project folder along side the TDD with the appropriate project name appending _script (e.g. Project_script.docx). **NOTE: If the exported Word document places page breaks between the narrative titles perform the following: 1. In the Word document, Home tab, Styles section, right-click the Storyboard Styles - Narration Number style and select Modify In the Modify Style dialog box, click the Format button at the bottom left and select Paragraph In the Line and Page Breaks tab, Pagination section, uncheck Page break before, then click the OK button. Page 12

13 Updating the Narrative Script Changes made in InDesign If changes to the script were made within Adobe InDesign the Word document must be updated in order to reflect those changes. 1. Click inside the Narration textframe to get a text cursor. 2. Right-click, select WordsFlow then Update Linked Document. Changes made in Word If changes to the script were made within the Word docuement the Adobe InDesign TDD must be updated in order to reflect those changes. 1. Save and close the Word document after making the changes. The Word document must be closed in order to accomplish the update. 2. Within Adobe InDesign the Narration textframes should show an warning exclamation point icon next to the WordsFlow icon. 3. Using the Selection tool, click the exclamation point icon to update the the link -or- from the Links tab, right-click on the document and select Update Link. A chain link icon should appear as confirmation. IMPORTANT: 1. When updating from Word some of the Word styles cross over into Adobe InDesign paragraph styles. Right-click and delete these styles they are not needed. NOTE: If a dialog box appears reasign the deleted Word style to the appropriate Adobe InDesign paragraph style (e.g. Reassign Storyboard:Styles:Narration Body to Narration Body. 2. Some Adobe InDesign styles may become confused within the Narration textframes, too. To fix this issue perform the following: a. Click inside the Narration textframe to get a text cursor. b. Select all of the text (Ctrl-A). c. Select the Character Styles tab and click [None]. This should clear any character style overrides applied during the update. Page 13

14 Placing Artwork When building the TDD you must place artwork onto the gridded storyboard panels in order to represent the design and movements to the developer. Images, Photoshop, and Illustrator files may be used to create in then dynamically edited from the TDD. 1. File > Place... (Ctrl-D) 2. In the Place dialog box, select the image file (e.g..ai,.psd,.png,.jpg, etc.), check Show Import Options and click Open. 3. In the resulting dialog box, select the options based on what you wish to import. The options vary based on the type of file. Illustrator files give you the flexibility to import full artboards and show various layers. Photoshop files let you choose which layers to import. A Helpful Note: Copying and pasting a previously linked Adobe Illustrator file or Photoshop file and changing the layer visibility settings from the Object Layer Options... dialog is a fast way to add new imagery rather than using the full placement process. Object Layer Options... are located under the Object menu -or- by right-clicking on the object. Illustrator Options Photoshop Options Image Options Page 14