<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>
You can set to exclude content based on its metadata. By
- default, all content is included.
-
-
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:
-
-
- 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.
You can set to flag content based on metadata. By default, no
- content is flagged.
-
-
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:
-
-
- 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:
- 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.
- 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.
-
You can show the revision information for your content. All
- revision information is hidden by default.
-
-
- 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:
-
-
- 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:
-
- 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.
-