文件範本定義報告的結構、佈置和內容。
建立成功的範本需要規劃、開發、測試及儲存範本。
1: 收集需求
不同的需求必須有不同的設計。
開始設計範本之前,請先判斷文件的商業需求和實際需求。
- 資料元素
- 有多種範本元素會顯示不同類型的資訊。
檢視文件的人將會需要哪些資訊?
知道這一點之後,您就可以開始決定資料元素:
- 哪些範本元素會顯示這個資料?在最終文件中,它的外觀會如何?
- 有多種顯示資訊的方式嗎?若是如此,哪種顯示方式最適合文件的檢視環境?
- 有多少必要的資料?您也許可以過濾掉不必要的資料,以便在產生報告輸出時節省時間。
- 輸出類型
- 請考量哪個輸出類型最符合檢視文件人員的需求。當您設計的範本產生成不同的輸出類型時,看起來可能會不同。有些元素進行了最佳化,適合以特定格式來顯示,有些不支援某些格式。請讓自己熟悉範本元素在不同輸出格式中的顯示方式。這樣,您就可以選取互相搭配得最好的元素和輸出類型。
- 單一範本與許多範本
- 這是單一用途的範本,或您有可能在其他範本中重複使用某些片段?
- 單一範本:您可以利用單一範本來包含文件設計中所有不同的部分。
這表示所有項目集中在單一位置,不需要進行合併。
- 許多範本:您可以使用模組化方式,建立多重範本,再將它們合併起來,建立完整文件。
例如,您可以有目錄範本、封面範本、資料範本、索引範本以及封底範本。這些範本可以在產生不同文件時重複使用。
決定提供這些需求所需的範本數。
您可以在 meta 資料屬性中命名並說明每一個範本區塊。
名稱內容會顯示在範本中,而說明內容則會顯示在範本元素提示欄位中。
- 檢視環境定義
- 某個人會如何檢視這份文件?
- 將它印出來?在畫面上檢視?兩者兼而有之?
- 會在整合產品中執行它嗎?
2:設計範本
當設計範本時,下列策略可協助您有效利用時間。
- 利用由上而下的方法實作範本的整體結構。請從最一般性的元素開始,然後逐漸縮小到詳細資料。
- 重點落在詳細資料的格式化之前,先驗證資料的產生。
如果您花很多時間進行格式化,後來才發現資料產生不正確,您可能需要重新格式化。
請參閱 3. 測試範本,以取得詳細資料。
- 修飾細節,並逐一新增更詳細的需求。將較不重要的細節或困難的部分留到之後實作。請考量很難實現之需求的相關性,如同在成本效益分析中所做的一樣。
- 考慮利用 Script 來將資訊擷取為 Rational Publishing Engine 能夠有效使用的格式。
- 範本可設計來提供特定的頁面佈置內容,例如,頁面大小、方向、邊距、欄數,以及文件中最可能使用之段落類型的樣式。
- 範本可以包含:
- 文件結構元素,例如:段落、表格、清單和內容目錄。
- 文件佈置區塊,例如:主要頁面、樣式表、標頭和標底。
- 內部與外部使用者定義的樣式,例如:文字或段落格式化。文字格式化包括粗體、斜體、底線、字型大小和字型顏色。段落格式包括邊距、邊框、縮排,以及 JavaScript 形式的 Scripting 參數。
- 內嵌範本內容,例如:影像、靜態文字,以及靜態檔案和樣式表的參照。
- 資料元素,例如:屬性、條件和動態資料元素。
- 查詢和過濾器格式的資料擷取。
- 用來在執行時期接收值的外部變數,以及用於計算的內部變數。建議您建立外部變數,而非將範本中的資料來源 URL 寫在程式中。如果您將 URL 寫在程式中,當伺服器名稱變更時,您就必須更新每一個範本中的 URL。利用外部變數,您可以在執行時期置換 URL。如果範本內嵌在其他產品中,當其參照資料時,請使用這些產品可辨識的特殊變數。
- 啟動 Document Studio。
- 建立新範本,從頭開始,或以現有的範本為基礎。
- 新增資料來源綱目。
- 新增元素。
- 新增格式到元素中。
- 定義動態內容。
- 選用:利用過濾器、排序或條件來精簡資料。
3: 測試範本
- 測試會在開發期間漸進完成。請經常儲存,並以唯一名稱來儲存。請利用一組小量的測試資料來經常驗證輸出。在目前的項目可運作之前,請勿新增其他元素。
- 在開發大部分文件之後,請執行負載測試來檢查效能問題。請使用「預覽」工具來限制所使用的資料大小。所產生的報告仍然是正確的,但執行的速度較快,因為 Rational Publishing Engine 擷取的每一項查詢的預設記錄數上限是 10 筆記錄。在測試條件時,有可能前 10 筆中沒有任何記錄符合條件。在此情況下,請使用「執行」工具而非「預覽」工具,或是在「喜好設定」中變更每一項查詢的記錄數上限值。
- 以不同的輸出格式來測試範本。您可能會發現某種輸出類型不會顯示您的範本以及另一種輸出類型。
- 執行驗證工具。
- 產生預覽。
4: 儲存範本
- 在中央檔案伺服器上儲存已開發和已測試的範本。
您可以使用「中央管理」元件作為儲存體位置。
- 請務必在範本 meta 資料中提供某些資訊,讓其他人知道如何重複使用該範本。某些範例資料和專案資料的範例文件規格資訊,有助於有效地重複使用這些範本。