From 47b1a48def56da1d7d8b26eec409828cec4bbfec Mon Sep 17 00:00:00 2001 From: YuCheng Hu Date: Wed, 26 May 2010 03:14:45 +0000 Subject: [PATCH] =?UTF-8?q?=E5=B0=86=E6=96=87=E4=BB=B6=E6=B7=BB=E5=8A=A0?= =?UTF-8?q?=E5=B9=B6=E5=AF=BC=E5=85=A5=E5=88=B0SVN=E5=BA=93=E4=B8=AD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit +YUCHENG HU+ git-svn-id: https://svn.code.sf.net/p/hawebs/svn@47 a2543c7e-f6e9-4f8a-8bff-1ffc34733512 --- .../trunk/src/userguide/tasks/addmeta.dita | 91 ++++++ .../trunk/src/userguide/tasks/condproc.dita | 150 ++++++++++ .../src/userguide/tasks/filtcontent.dita | 76 +++++ .../src/userguide/tasks/flagcontent.dita | 114 ++++++++ .../userguide/tasks/info/apachelicense.dita | 266 ++++++++++++++++++ .../src/userguide/tasks/info/hacopyright.dita | 51 ++++ .../trunk/src/userguide/tasks/proccond.dita | 21 ++ .../trunk/src/userguide/tasks/showrev.dita | 104 +++++++ 8 files changed, 873 insertions(+) create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/addmeta.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/condproc.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/filtcontent.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/flagcontent.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/info/apachelicense.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/info/hacopyright.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/proccond.dita create mode 100644 hadocs/dita-ot/trunk/src/userguide/tasks/showrev.dita diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/addmeta.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/addmeta.dita new file mode 100644 index 00000000..12857603 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/addmeta.dita @@ -0,0 +1,91 @@ + + + + + + Adding metadata to elements + You can use attributes to provide information about what + product, audience, or platform an element applies to, or what revision + it belongs to. + + + + metadata + attributesadding + adding metadata attributes + + + + + Before using these attributes, work with your team to agree on + a consistent set of values for use across your information set. Do + not define your own values without consulting team mates, or your + content might not build properly when reusing it. + Use these attributes when you have content within a topic or a + map that applies to only one or some of the products, platforms, or + audiences for the topic or map as a whole. + + + Find the element you want to provide information for. + If there are not attributes you need in the element, + create a new element inside it, like a ph, which can hold + the attributes instead. + + + Enter the value of attribute for the information you want + to provide: + + + + audience + The audience that the element applies to, Could + be a user role (like administrator), experience + level (novice), or combination + (novice-admin). + + + platform + The platform (typically hardware, operating + system, or both) that the element applies + to. + + + product + The product that the element applies + to. + + + otherprops + Any other category of metadata. + + + rev + The revision that the element belongs to, if + the topic has been revised and you want to track + what stage particular content was added at. + + + + + Add a value or values to the attribute. + For example, audience="novice-admin expert-user" or + platform="wintel". + + + For audience or product, add an equivalent + element to the prolog metadata. + You can provide more information about your audience or + product values in the topic's prolog, inside the metadata + element. To ensure consistency, you can define the elements + in one place for the entire information set, and then reuse + them in topics that require them by using the conref + attribute. + + + Metadata attributes are inherited: they apply to any elements + they contain as well. In a table, metadata for a column applies to + all the cells in the column. + + \ No newline at end of file diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/condproc.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/condproc.dita new file mode 100644 index 00000000..0db1b352 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/condproc.dita @@ -0,0 +1,150 @@ + + + + + + 条件处理 + Conditional processing means filtering or flagging information + based on processing-time criteria, such as a target audience, platform, + or product. + + + + metadata attributes + product attribute + platform attribute + audience attribute + rev attribute + otherprops attribute + conditional processing + + + + +

The arbitrary values can accumulate in a document over time and + have meaning only to the original author. However, you can use a + set of standard metadata attributes on content instead of them. + Rather than being suitable for filtering only, you can use the + metadata for filtering, flagging, and future search and retrieval + processes, because it is process-independent and merely provides + information about the content.

+

The following attributes are intended for conditional processing, + and are available on most elements:

product
+
The product that is the subject of the content, or to which the + content applies.
platform
The + platform on which the product is deployed.
 +
audience
The intended audience for the content.
+
rev
The revision or draft during + which the content was added or changed. You can only flag + revisions, not exclude them.
 +
otherprops
Anything else.

+

Each attribute takes zero or more space-delimited string values. For + example, you can use the product attribute to identify that an + element applies to two particular products.

+

Coordinate the values you use with your team, so that all the + information can be consistently processed with the same value + definitions.

+

At processing time, specify the values you want to exclude and the + values you want to flag.

+
+ Setting conditions +

You can define what to do with these values in a filtering file. + Open the ditaval file to edit it, and input the actions to take + for the properties and revisions you want to process.

+

At processing time, you can specify the filter file by entering + the /filter:{args.input.valfile} output option + to name the ditaval file that has these entries.

+
+
+ Excluding information +

Specify the attribute and value you want to exclude. For + example, exclude when audience="admin". For an element to be + excluded, all the values in at least one attribute must be set + to exclude. For example, if a paragraph applies to two + audiences (audience="admin programmer") both values must be set + to exclude in the filtering file before the paragraph is + excluded.

+

You cannot exclude revisions, only choose whether or not to flag + them.

+
+
+ Flagging information +

Specify the attribute and value you want to flag. On output, the + element will be flagged with the image you specify, or, in the + case of revisions, with the method you specify. For an element + to be flagged, at least one flagged value must be present. For + example, if a paragraph applies to two audiences, either one + set to flag will flag the element.

+
+ + Example +

Given this source:<ul> + <li audience="admin programmer"> + This is important for lots of reasons + </li> + <li audience="programmer"> + This is only important to programmers + </li> + <li audience="programmer" platform="unix"> + This is only important to Unix programmers + </li> + <li platform="unix"> + This applies on Unix + </li> +</ul>

+

And this filter file: + Attribute Value Action + Flag + audience programmer + exclude + platform unix flag + ../images/ngunix.gif +

+

You should get this output:

  • This is + important for lots of reasons
  • This applies on Unix
    • +

+

The first list item remains because it applies to admin audience + and programmer audience. The second list item is removed + because it applies to programmers only, and programmer-specific + information has been excluded. The third list item is removed + because it applies to programmers as well: the fact that it + applies to the Unix platform does not save it from exclusion. + The fourth list item is flagged based on its platform + attribute.

+ + + \ No newline at end of file diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/filtcontent.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/filtcontent.dita new file mode 100644 index 00000000..c94307af --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/filtcontent.dita @@ -0,0 +1,76 @@ + + + + + + 过滤内容 + You can set to exclude content based on its metadata. By + default, all content is included. + + + + metadata attributesfiltering + on + filtering content + + + + + All the values in at least one attribute must be set to + exclude for an element to be filtered out. + + + Create a DITA filter file in the directory you want to add + the file to. Give the file a descriptive name, such as + "audience-flag-build.ditaval". + + + Open the file, and type below content into it: + + <?xml version="1.0" encoding="UTF-8"?> +<val> </val> + + + + Define the property you want to exclude: + + + Find the attribute name. Type a new property for + exclude by adding a new line <prop att="" val="" action="exclude"/>. + + + Select the attribute ("audience", "platform", + "product", "otherprops") you want to exclude based + on. + For example, "audience". + + + Type the value you want to exclude. + For example, "programmer". + + + You can define more properties by following the steps + above. The final ditaval file with the example values should be like + this: + + <?xml version="1.0" encoding="UTF-8"?> +<val> + <prop att="audience" val="programmer" action="exclude"/> +</val> + + + + When you publish output from the topic or map, specify the + filter file you want by using the parameter + /filter:{args.input.valfile} for the output options. + + + Content is excluded only when all the values in a single + attribute are set to exclude. For example, if you have a list item + that applies to programmer and administrator audiences, and you + exclude programmers, the list item will remain in the output + because it still applies to administrators. + + \ No newline at end of file diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/flagcontent.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/flagcontent.dita new file mode 100644 index 00000000..b20babe1 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/flagcontent.dita @@ -0,0 +1,114 @@ + + + + + + 标记内容 + You can set to flag content based on metadata. By default, no + content is flagged. + + + + metadata attributesflagging + on + flagging content + + + + + Define a common set of images, and common alternative text for + them, so that you can flag consistent content across your + information set. Generally flagging is supported for block-level + elements such as paragraphs, but not for phrase-level elements + within a paragraph. This ensures that the images flagging the + content are easily scanned by the reader, instead of being buried + in text. + +

At least one value in at least one attribute must be set to flag + for the element to be flagged.

+ + + + Create a DITA filter file in the directory you want to add + the file to. Give the file a descriptive name, such as + "audience-flag-build.ditaval". + + + Open the file, and type below content into it: + + <?xml version="1.0" encoding="UTF-8"?> +<val> </val> + + + + Define the property you want to flag: + + + Type a new property for flag by adding a new line + <prop att="" val="" action="flag" img="" alt=""/>. + + + Select the attribute ("audience", "platform", + "product", "otherprops") you want to flag based on. + + For example, "audience". + + + Type the value you want to flag. + For example, "programmer". + + + Enter the image you want to use to flag the + content. Local absolute paths, or relative + paths from the filter file both are supported. + For example, "D:\resource\delta.gif". + + + Type the alternate text for the image that will be + used by screen readers. + For example, "sample alt text". + + + You can define more properties by following the steps + above. The final ditaval file with the example values should be like + this:<?xml version="1.0" encoding="UTF-8"?> +<val> + <prop att="audience" val="programmer" action="flag" img="D:\resource\delta.gif" alt="sample alt text"/> +</val> + + + When you publish output from the topic or map, specify the + filter file you want by using the parameter + /filter:{args.input.valfile} for the output options. + + + Content is flagged when any of the flagged values appears in + any of the attributes. When flagged values are found in a map, + links that are generated from affected topicrefs will be flagged on + output. + + Examples +
+ +
<p audience="admin programmer">
+
+

When admin is set to flag, the paragraph will be + preceded by the image you specified for admin.

+

When both values are set to flag, both images will + appear before the paragraph.

+
+ + +
<topicref platform="linux" href="abc.dita">
+
When linux is set to flag, any links to abc.dita + derived from this topic reference will be flagged with + the image you specified. In addition, any links derived + from child topicrefs will also be flagged: metadata + attributes are inherited.
+ +
+ + + \ No newline at end of file diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/info/apachelicense.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/info/apachelicense.dita new file mode 100644 index 00000000..0b61360c --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/info/apachelicense.dita @@ -0,0 +1,266 @@ + + + + + + Apache 许可证 + + + + + Apachelicense + + + + +
+ Apache许可证，版本2.0 + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, + reproduction, and distribution as defined by Sections 1 through + 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized + by the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under + common control with that entity. For the purposes of this + definition, "control" means (i) the power, direct or indirect, + to cause the direction or management of such entity, whether by + contract or otherwise, or (ii) ownership of fifty percent (50%) + or more of the outstanding shares, or (iii) beneficial ownership + of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making + modifications, including but not limited to software source code, + documentation source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or + Object form, that is based on (or derived from) the Work and + for which the editorial revisions, annotations, elaborations, + or other modifications represent, as a whole, an original work + of authorship. For the purposes of this License, Derivative + Works shall not include works that remain separable from, or + merely link (or bind by name) to the interfaces of, the Work + and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or + additions to that Work or Derivative Works thereof, that is + intentionally submitted to Licensor for inclusion in the Work + by the copyright owner or by an individual or Legal Entity + authorized to submit on behalf of the copyright owner. For the + purposes of this definition, + "submitted" means any form of electronic, verbal, or written + communication sent to the Licensor or its representatives, + including but not limited to communication on electronic mailing + lists, source code control systems, and issue tracking systems + that are managed by, or on behalf of, the Licensor for the + purpose of discussing and improving the Work, but excluding + communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a + Contribution." + + "Contributor" shall mean Licensor and any individual or Legal + Entity on behalf of whom a Contribution has been received by + Licensor and subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions + of this License, each Contributor hereby grants to You a + perpetual, worldwide, non-exclusive, no-charge, royalty-free, + irrevocable copyright license to reproduce, prepare Derivative + Works of, publicly display, publicly perform, sublicense, and + distribute the Work and such Derivative Works in Source or + Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have + made, use, offer to sell, sell, import, and otherwise transfer + the Work, where such license applies only to those patent claims + licensable by such Contributor that are necessarily infringed by + their Contribution(s) alone or by combination of their + Contribution(s) with the Work to which such Contribution(s) was + submitted. If You institute patent litigation against any entity + (including a cross-claim or counterclaim in a lawsuit) alleging + that the Work or a Contribution incorporated within the Work + constitutes direct or contributory patent infringement, then any + patent licenses granted to You under this License for that Work + shall terminate as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute + must include a readable copy of the attribution notices + contained within such NOTICE file, excluding those notices + that do not pertain to any part of the Derivative Works, in + at least one of the following places: within a NOTICE text + file distributed as part of the Derivative Works; within the + Source form or documentation, if provided along with the + Derivative Works; or, within a display generated by the + Derivative Works, if and wherever such third-party notices + normally appear. The contents of the NOTICE file are for + informational purposes only and do not modify the License. + You may add Your own attribution notices within Derivative + Works that You distribute, alongside or as an addendum to + the NOTICE text from the Work, provided that such additional + attribution notices cannot be construed as modifying the + License. + + You may add Your own copyright statement to Your modifications + and may provide additional or different license terms and + conditions for use, reproduction, or distribution of Your + modifications, or for any such Derivative Works as a whole, + provided Your use, reproduction, and distribution of the Work + otherwise complies with the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state + otherwise, any Contribution intentionally submitted for + inclusion in the Work by You to the Licensor shall be under the + terms and conditions of this License, without any additional + terms or conditions. Notwithstanding the above, nothing herein + shall supersede or modify the terms of any separate license + agreement you may have executed with Licensor regarding such + Contributions. + + 6. Trademarks. This License does not grant permission to use the + trade names, trademarks, service marks, or product names of the + Licensor, except as required for reasonable and customary use + in describing the origin of the Work and reproducing the content + of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or + conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or + FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for + determining the appropriateness of using or redistributing the + Work and assume any risks associated with Your exercise of + permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and + grossly negligent acts) or agreed to in writing, shall any + Contributor be liable to You for damages, including any direct, + indirect, special, incidental, or consequential damages of any + character arising as a result of this License or out of the use + or inability to use the Work (including but not limited to + damages for loss of goodwill, work stoppage, computer failure or + malfunction, or any and all other commercial damages or losses), + even if such Contributor has been advised of the possibility of + such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by + reason of your accepting any such warranty or additional + liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. + +
+ + diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/info/hacopyright.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/info/hacopyright.dita new file mode 100644 index 00000000..65e6bbdd --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/info/hacopyright.dita @@ -0,0 +1,51 @@ + + + + + + 版权信息 + +
+

+ HAWEBS信息技术股份有限公司(LOGO) +

+

版权所有 2004-2010 DITA OT 软件开发小组

+

中文参考手册版权所有 2006 - 2010 HAWEBS信息技术股份有限公司

+

基于Apache许可证， 版本2.0。你必须在基于许可证的要求下使用本软件，你可以通过下面的链接来获得相关的具体内容 http://www.apache.org/licenses/LICENSE-2.0。

+
+
+ 相关信息 +

+
+ + diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/proccond.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/proccond.dita new file mode 100644 index 00000000..90ce3f6a --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/proccond.dita @@ -0,0 +1,21 @@ + + + + + + 过滤与标记内容 + You can use metadata on elements to filter or flag content, and + to show revised content. + + + + filtering content + flagging content + conditional processing + + + + + \ No newline at end of file diff --git a/hadocs/dita-ot/trunk/src/userguide/tasks/showrev.dita b/hadocs/dita-ot/trunk/src/userguide/tasks/showrev.dita new file mode 100644 index 00000000..0441caef --- /dev/null +++ b/hadocs/dita-ot/trunk/src/userguide/tasks/showrev.dita @@ -0,0 +1,104 @@ + + + + + + 显示版本 + You can show the revision information for your content. All + revision information is hidden by default. + + + + metadata attributesshowing + revisions + revisionsshowing + showing revisions + + + + + + + Create a DITA filter file in the directory you want to add + the file to. Give the file a descriptive name, such as + "audience-flag-build.ditaval". + + + Open the file, and type below content into it: + + <?xml version="1.0" encoding="UTF-8"?> +<val> </val> + + + + Define the revision you want to show: + + + Add a new property for flag by adding a new line + <revprop val="" style="" action="" date=""/>". + + + + Type the name of the revision you want to show. + For example, "rev1". + + + Enter the date of the revision, or the date it + started or ended. + For example, "05-10-11". + + + Define how the revision will be flagged in XHTML: + either by images or colors. + +
    +
  • Type the value of style if the revision + will be flagged with color, either by using + the RGB codes or color. For example, + "#008040" or "Green". Type the + value of action. For example, "noflag".
    • +
  • Enter the value of action if the revision + will be flagged with image. For example, + "flag".
    • +
+ + Use images instead of color to ensure that your + output is flagged consistently and accessibly. + Color only works for flagging phrase-level + information, and can not be distinguishable to + color-blind readers, on monochrome displays, or + once an online page is printed. Note: If both style + and action="flag" are used, the revision will be flagged + by both of them. + + + Enter the character to use when flagging the + revision in PDF. + For example, "A". +

Revision indication for PDF output will be specific to + each implementation. See the documentation for your preferred + FO/PDF output transform as to whether conditional markup and + revisions are supported and how.

 + + + You need to define a separate property for each revision + you want to show. For example, if you want to show two + revisions, you would need to define each separately. + You can define more properties by following the steps + above. The final ditaval file with the example values should be like this: + <?xml version="1.0" encoding="UTF-8"?> +<val> + <revprop val="rev1" style="Green" action="noflag" date="2005-10-08" /> + <revprop val="rev2" action="flag" date="2005-10-10" /> +</val> + + + When you publish output from the topic or map, specify the + filter file you want by using the parameter + /filter:{args.input.valfile} for the output options. + + + + \ No newline at end of file