PART-1: Package Version Information | |
---|---|
Package Version | 1.0 |
PART-2: IDWB Information | |
---|---|
Base | V4.5.0 |
Patch | ID04050003W |
Packaging Tool | V4.5.0 |
PART-3: Package Profile | |
---|---|
Source | DITA |
Status | final |
Creation date | 05/13/14 10:12:28 |
Package File Name | BF8K2ABD001.pkg |
Embedded Files | BF8K2ABD001.zip, BF8K2ABD001.out, BF8K2ABD001.lst, BF8K2ABD001-readme.xml, BF8K2ABD001pkg.log |
Author | |
Name | Bert Paul |
bertpaul@us.ibm.com | |
Notes Short ID | |
Alternate | |
Sender | |
Name | Bert Paul |
bertpaul@us.ibm.com | |
Notes Short ID | |
Alternate | |
Contact Point | |
Name | Bert Paul |
bertpaul@us.ibm.com | |
Notes Short ID | |
Alternate | |
Contact Point Backup 1 | |
Name | Rick Hardison |
hardison@us.ibm.com | |
Notes Short ID | |
Alternate | |
Contact Point Backup 2 | |
Name | Donna DaCosta |
ddacosta@us.ibm.com | |
Notes Short ID | |
Alternate |
PART-4: TPMS Information | |
---|---|
Charge To ID | BF8K2ABD001 |
Shipment Name | BF8K2_DOC02 |
Form Number | Not Applicable |
Product Release Level | Rational Build Forge Version 8.0 |
Document Title | Rational Build Forge Information Center |
PART-5: Translation Information | |
---|---|
Translation Returns | |
Output for com.ibm.bf.pdf.doc.ditamap | |
Input file | com.ibm.bf.pdf.doc.ditamap |
Return to Lab | SRC PDF XHM |
Sent to Manufacturing | XHM |
Processing Extensions | |
DITA Plugins | |
Files | |
Files With No Word Count | footerIC.txt, hdf_rational.txt, rational.xsl, com.ibm.bf.pdf.docpdf.bom, com.ibm.bf.pdf.docpdf.log, com.ibm.bf.pdf.docxhm.bom, com.ibm.bf.pdf.docxhm.log, BF80_CODEPAGE_CHKPII.TXT, BF80_NEW_CHANGED_CHKPII.TXT, default.sch |
Common Files | |
Shared Files | |
Special | |
Return | *************************** INSTRUCTIONS to TRANSLATORS *************************** TPMS Shipment Name: BF8K2_DOC02 Charge to ID: BF8K2ABD001 Package Type: Pubs Translation Unit: BF8K2ABD001 - IBM Rational Build Forge Information Center Product: IBM Rational Build Forge 8.0 Component: Plug-in name (list plug-ins) com.ibm.rational.buildforge.doc Contacts: Development Contact: Bert Paul bertpaul@us.ibm.com Back-up contact: Rick Hardison hardison@us.ibm.com SCHEDULE - FINAL PACKAGE SHIPMENT Drop date: 05/12/2014 Return date: 05/16/2014 ******* RETURNS ******* Return a single zip file containing the plugin output and the source. Use the plugin name as the top level of the zip, for example "com.ibm.rational.buildforge.doc". Do not name the top folder "output" or other name. Return the following: - XHTML output (follow XHTML instructions below) Include the translated helpindex_bf.html file - PDF output - (follow SPECIAL INSTRUCTIONS TO PRODUCE A PDF FROM COM.IBM.BF.PDF.DOC.IDD below) NOTE: Ignore Warnings in PDF build about "Text has printed outside of the currently defined area. See the first occurrence of this message in the log for a full explanation. " Some examples run a little into the margins, it is not a problem. NOTE: due to special requirements for including the PDF in the IC, you must package the return for XHTML first, then create and add the PDF file manually. Naming conventions: Name your return ZIPs using the following convention: [TPMS Charge-to ID].[shipment name].[country initials].[return number].zip Example: BF8002BD001.BF8002_DOC01.it.01.zip Group 1 Country Initials ---------------- Brazil = br France = fr Germany = de Italy = it Japan = ja Korea = ko Simplified Chinese = cn Spain = es Traditional Chinese = tw Please return the files to the following location: /gsa/bejgsa/projects/g/g11nftp/Rational/BF8K2/DOC02/NLV Use your own GSA userid when returning these files. Thank you! </return> <communication /> <others> ****************** FILES TO TRANSLATE ****************** Please translate: 1. .dita files (in com.ibm.rational.buildforge.doc/topics) 2. com.ibm.bf.pdf.doc.idd (in com.ibm.rational.buildforge.doc - added separately) 3. helpindex_bf.html (added separately - add manually to the XHTML returns) NON-TRANSLATABLE FILES hdf_rational.txt and rational.xsl are non-translatable files used in the transform. FooterIC.html is translatable but is used in the transform and is not returnable. Do not return these files. Any CHKPII errors in rational.xsl can be ignored as this file is not translatable. ========================================= PRODUCING XHTML - TRANSFORMING DITA FILES ========================================= Preparing to transform DITA: Note: If you are not working with the contents of this package in the following base directory "C:\[package_name]", edit the DITA search path file (*.dsh file) to reflect your working location. 1. Copy the translated content of the following common plug-ins into your working directory: * com.ibm.help.sourcedita.doc TPMS:XHELP Charge to ID: BF800 These plug-ins must be in your working directory so that during your transformation, their content can be substituted into files that refer to common content. 2. In your working directory, create a subdirectory called output. This subdirectory will hold the results of your transformation. 3. Create a subdirectory c:\[package_name]\output\[plugin_name] where [plugin_name] is the same name as the maplist files. For example: maplist file name = com.ibm.rational.buildforge.doc.maplist output path = c:\[package_name]\output\com.ibm.rational.buildforge.doc 4. Copy hdf_rational, rational.xsl, footer.html into the root of your working directory. You are now ready to transform the DITA source topics. Transforming DITA to XHTML: 1. Choose a maplist to work with. 2. Right click a maplist file and click Work with ID Workbench. 3. Check to see if there are matching ditaval files (not all maplists will have a .ditaval file associated with them). 4. In the ID Workbench dialog box, in the Process pane, click Generate XHTML, then click New. 5. Step through the tabbed pages and type the following values: Parameter: Value: /OUTDIR C:\[package_name]\output\[plugin_name] /FILTER C:\[package_name]\output\[plugin_name].ditaval. If there is no matching DITAVAL file, you can ignore this parameter) /HDF hdf_rational.txt /FTR footerIC.html /OUTEXT html /NAVTYPE Eclipse (Eclipse Help) /NOPARENTLINK ON / OUTDIRSCOPE: LIMITWARN Additional Options: /XSL:rational.xsl 6. Click Save and then click Run. 7. Check that the transformation generates no errors. Read the log files for more detailed results. You can ignore warnings. 8. Check that the output\[plugin_name] directory contains *.html files in a topics subdirectory. If there are images, they should be in an images subdirectory. XML files should be in the root of output\[plugin_name]. You should see XML TOC files that have the same name as the ditamap files. Note: Please look at the contents of the _toc.xml files, and verify that they have been translated appropriately. If you are using a ditamap file that calls files outside the plug-in, you must translate the associated title of the file manually. 9. If there are no 'Fatal' errors in the logs and the output contents look correct, move on to the next maplist file. Repeat the procedure for each maplist file to create an HTML plug-in for each of the plug-ins listed under "Component" above. ************************************************************************ SPECIAL INSTRUCTIONS TO PRODUCE A PDF FROM COM.IBM.BF.PDF.DOC.IDD ************************************************************************ This process produces a PDF of the entire IC except for elements that are used only on the web. The PDF installed along with the IC. A topic in the IC links to the PDF. 1. INPUT FILES - the following en_US files were added to the translation package. The translated equivalents should be in translation memory (from previous release) a. com.ibm.bf.pdf.doc.idd b. com.ibm.bf.pdf.doc.ditamap c. com.ibm.bf.pdf.doc.pdf (PDF file produced in en from .idd file) d. com.ibm.bf.pdf.docps.bom (BOM from producing en PDF file) e. com.ibm.bf.pdf.docps.log (log from producing en PDF file) f. unzipped images files (EPS) - BF800_images_NLV.zip. NOTE: no changes for BF800 - TMB should have these NOTE: all NLV images should be in translation memor - both .eps and .gif files in images/ and images/icons. 2. Place the files - a, b, c, d, e: place these files in com.ibm.rational.buildforge.doc 3. Complete translation of all .dita files in com.ibm.rational.buildforge.doc/topics 4. Translate com.ibm.bf.pdf.doc.idd 5. Build the PDF from the .idd file as follows: a. Right click on your IDD file b. Choose "Work with ID Workbench..." c. Choose "Format to PostScript using Xyvision" d. On the Directories tab of the resulting dialog: i. For "Client Only Search Path" use "default.sch" ii. Do not check "Perform file retrieval from both..." iii. Choose an output directory for the PDF e. On the Transform tab, leave all items blank except: i. DTD declaration = "IBMIDDOC Codepage 850 for English and all languages not listed below" ii. Message level = Error f. Use defaults on the Style, Xyvision-1, and Xyvision-2 tabs g. On the Distill tab: i. Check "Convert generated Postscript file to PDF" h. On the Print tab: i. Check "Do not print the generated output" i. Leave defaults on Misc. tab j. Click "Save" and "Run" at the bottom of the dialog. 6. Place the output PDF file (com.ibm.bf.pdf.doc.pdf) in com.ibm.rational.buildforge.doc. 7. PACKAGING: When you package files for return, add the PDF file (com.ibm.bf.doc.pdf) to the package manually ("Additional Files") ************************************************************************ FILE TREATMENT ************************************************************************ PROPERTIES FILES Translate the PROPERTIES file using TM. Translate the string to the right of the "=" sign only. Return the properties files as plugin.properties files. Do NOT rename them to your country's locale. GRAPHICS FILES The .cdr files in the "images" directory are translated. If there are changes, produce .eps and .gif output and return them in the images directory. (NOTE: 713I4 - no changes) All other .gif files provided are screen captures and do not have .cdr source. WARNING MESSAGES ABOUT IMAGE FILES Warnings about missing graphics files can be ignored. Do NOT TRANSLATE words that contain all capital letters. Such as, MB, RAM MSI, JAR, JAVA_HOME, IBMRAC, z/OS, SMC, and CVS, to name a few. However, the following words that contain all capital letters *should* be translated: REQUIRED and OPTIONAL a. Pre-shipment tests chkpii passes all files with zero errors segchk passes all files except these: (1) adaptor_xml_execute.dita adaptor_xml_integrate.dita adaptor_xml_notify.dita adaptor_xml_relate.dita adaptor_xml_requeue It is interpreting the title as a sentence and requesting an object for a verb. The titles are keywords and should not be translated. If this is a markup issue let me know. <title>execute</title> (2) altinst_manual_im__top.dita config_sec_sso_framework_about.dita Errors are in <codeblock> elements. Do not translate inside <codeblock> elements. d. IMPORTANT: all files are in UTF-8 encoding. Do not change the encoding. e. IMPORTANT: validate the .dita files before returning. Only Arbortext/Epic Editor should be used to make changes. If another tool is used, please validate the file before returning. Defects in the XML break the build and are time-consuming to find. We have seen many errors introduced in translation in the <menucascade> elements. No text is allowed between it and the <uicontrol> elements it contains. |
Communication | TCT - project BF8K2 |
Others | ************************************************************************ SPECIAL NOTES: ************************************************************************ a. Ignore any warnings about missing artwork files. They are not needed. No artwork changed or needs to be translated. b. DO NOT TRANSLATE text that is in <draft-comment> tags. They are internal comments. Example: <draft-comment>RATLC01004867 renamed commands in table</draft-comment> |
PART-6: IDWB Transform | |
---|---|
Dita | |
Input | com.ibm.bf.pdf.doc.ditamap |
Output | com.ibm.bf.pdf.doc.idd |
Output Format | PDF/PS |
Processor | map2pdf |
Parameters | /OUTDIR:.\out /WL:ERROR /STYLE:default /PDFLINK:BLUE /PDF:ANY /FONT:NONSTD /GRAPHICS:STORE /IMAGETYPES:eps /RELLINKS:DEFAULT |
Property File | |
Filter File | |
Build Notes | No special processing for this job |
IDWB Info | Base: ID Workbench V4.5.0 (08/21/2013) Transform: ID Workbench V4.5.0 (08/21/2013) Patch Files: Xyvision: ID Workbench V4.5.0 (08/21/2013) |
Dita | |
Input | com.ibm.bf.pdf.doc.ditamap |
Output | |
Output Format | XHTML |
Processor | map2xhtml |
Parameters | /OUTDIR:.\out /WL:ERROR /COPYCSS /OUTEXT:html /OUTDIRSCOPE:ADJUST /NAVTYPE:NONE |
Property File | |
Filter File | |
Build Notes | No special processing for this job |
IDWB Info | Base: ID Workbench V4.5.0 (08/21/2013) Transform: ID Workbench V4.5.0 (08/21/2013) Patch Files: |
External Files | |
Names |