1、 IEEE Standard for Documentation Schema for Repair and Assembly of Electronic Devices Sponsored by the IEEE Consumer Electronics Standards Committee IEEE 3 Park Avenue New York, NY 10016-5997 USA IEEE Consumer Electronics Society IEEE Std 1874-2013IEEE Std 1874-2013 IEEE Standard for Documentation S
2、chema for Repair and Assembly of Electronic Devices Sponsor IEEE Consumer Electronics Standards Committee of the IEEE Consumer Electronics Society Approved 11 December 2013 IEEE-SA Standards Board Abstract: oManual is a standard for storing and transmitting procedural manuals. oManuals common data f
3、ormat can be used as an offline file package or via online RESTful API endpoints, using XML or JSON. This format is useful for documenting and describing repairs, how-to, work instructions, or any other step-by-step guides. oManual makes it easy to exchange procedural information between services wh
4、ile maintaining usability on mobile devices. This specification describes the oManual data model, web services API, and bundle file format (a collection of structured files containing a category XML format, a guide XML format and related multimedia). The specification may be expanded in the future t
5、o enable additional types of documents. Keywords: IEEE 1874, JSON, manual, oEmbed, oManual, RESTful API, XML, ZIP The Institute of Electrical and Electronics Engineers, Inc. 3 Park Avenue, New York, NY 10016-5997, USA Copyright 2014 by The Institute of Electrical and Electronics Engineers, Inc. All
6、rights reserved. Published 15 January 2014. Printed in the United States of America. IEEE is a registered trademark in the U.S. Patent fitness for a particular purpose; non-infringement; and quality, accuracy, effectiveness, currency, or completeness of material. In addition, IEEE disclaims any and
7、all conditions relating to: results; and workmanlike effort. IEEE standards documents are supplied “AS IS” and “WITH ALL FAULTS.” Use of an IEEE standard is wholly voluntary. The existence of an IEEE standard does not imply that there are no other ways to produce, test, measure, purchase, market, or
8、 provide other goods and services related to the scope of the IEEE standard. Furthermore, the viewpoint expressed at the time a standard is approved and issued is subject to change brought about through developments in the state of the art and comments received from users of the standard. In publish
9、ing and making its standards available, IEEE is not suggesting or rendering professional or other services for, or on behalf of, any person or entity nor is IEEE undertaking to perform any duty owed by any other person or entity to another. Any person utilizing any IEEE Standards document, should re
10、ly upon his or her own independent judgment in the exercise of reasonable care in any given circumstances or, as appropriate, seek the advice of a competent professional in determining the appropriateness of a given IEEE standard. IN NO EVENT SHALL IEEE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL
11、, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO: PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
12、OTHERWISE) ARISING IN ANY WAY OUT OF THE PUBLICATION, USE OF, OR RELIANCE UPON ANY STANDARD, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE AND REGARDLESS OF WHETHER SUCH DAMAGE WAS FORESEEABLE. Translations The IEEE consensus development process involves the review of documents in English only.
13、In the event that an IEEE standard is translated, only the English version published by IEEE should be considered the approved IEEE standard. Official statements A statement, written or oral, that is not processed in accordance with the IEEE-SA Standards Board Operations Manual shall not be consider
14、ed or inferred to be the official position of IEEE or any of its committees and shall not be considered to be, or be relied upon as, a formal position of IEEE. At lectures, symposia, seminars, or educational courses, an individual presenting information on IEEE standards shall make it clear that his
15、 or her views should be considered the personal views of that individual rather than the formal position of IEEE. Comments on standards Comments for revision of IEEE Standards documents are welcome from any interested party, regardless of membership affiliation with IEEE. However, IEEE does not prov
16、ide consulting information or advice pertaining to IEEE Standards documents. Suggestions for changes in documents should be in the form of a proposed change of text, together with appropriate supporting comments. Since IEEE standards represent a consensus of concerned interests, it is important that
17、 any responses to comments and questions also receive the concurrence of a balance of interests. For this reason, IEEE and the members of its societies and Standards Coordinating Committees are not able to provide an instant response to comments or questions except in those cases where the matter ha
18、s previously been addressed. For the same reason, IEEE does not respond to interpretation requests. Any person who would like to participate in revisions to an IEEE standard is welcome to join the relevant IEEE working group. Comments on standards should be submitted to the following address: Secret
19、ary, IEEE-SA Standards Board 445 Hoes Lane Piscataway, NJ 08854 USA Laws and regulations Users of IEEE Standards documents should consult all applicable laws and regulations. Compliance with the provisions of any IEEE Standards document does not imply compliance to any applicable regulatory requirem
20、ents. Implementers of the standard are responsible for observing or referring to the applicable regulatory requirements. IEEE does not, by the publication of its standards, intend to urge action that is not in compliance with applicable laws, and these documents may not be construed as doing so. Cop
21、yrights IEEE draft and approved standards are copyrighted by IEEE under U.S. and international copyright laws. They are made available by IEEE and are adopted for a wide variety of both public and private uses. These include both use, by reference, in laws and regulations, and use in private self-re
22、gulation, standardization, and the promotion of engineering practices and methods. By making these documents available for use and adoption by public authorities and private users, IEEE does not waive any rights in copyright to the documents. Photocopies Subject to payment of the appropriate fee, IE
23、EE will grant users a limited, non-exclusive license to photocopy portions of any individual standard for company or organizational internal use or individual, non-commercial use only. To arrange for payment of licensing fees, please contact Copyright Clearance Center, Customer Service, 222 Rosewood
24、 Drive, Danvers, MA 01923 USA; +1 978 750 8400. Permission to photocopy portions of any individual standard for educational classroom use can also be obtained through the Copyright Clearance Center. Updating of IEEE Standards documents Users of IEEE Standards documents should be aware that these doc
25、uments may be superseded at any time by the issuance of new editions or may be amended from time to time through the issuance of amendments, corrigenda, or errata. An official IEEE document at any point in time consists of the current edition of the document together with any amendments, corrigenda,
26、 or errata then in effect. Every IEEE standard is subjected to review at least every ten years. When a document is more than ten years old and has not undergone a revision process, it is reasonable to conclude that its contents, although still of some value, do not wholly reflect the present state o
27、f the art. Users are cautioned to check to determine that they have the latest edition of any IEEE standard. In order to determine whether a given document is the current edition and whether it has been amended through the issuance of amendments, corrigenda, or errata, visit the IEEE-SA Website at h
28、ttp:/ieeexplore.ieee.org/xpl/standards.jsp or contact IEEE at the address listed previously. For more information about the IEEE SA or IEEEs standards development process, visit the IEEE-SA Website at http:/standards.ieee.org. Errata Errata, if any, for all IEEE standards can be accessed on the IEEE
29、-SA Website at the following URL: http:/standards.ieee.org/findstds/errata/index.html. Users are encouraged to check this URL for errata periodically. Patents Attention is called to the possibility that implementation of this standard may require use of subject matter covered by patent rights. By pu
30、blication of this standard, no position is taken by the IEEE with respect to the existence or validity of any patent rights in connection therewith. If a patent holder or patent applicant has filed a statement of assurance via an Accepted Letter of Assurance, then the statement is listed on the IEEE
31、-SA Website at http:/standards.ieee.org/about/sasb/patcom/patents.html. Letters of Assurance may indicate whether the Submitter is willing or unwilling to grant licenses under patent rights without compensation or under reasonable rates, with reasonable terms and conditions that are demonstrably fre
32、e of any unfair discrimination to applicants desiring to obtain such licenses. Essential Patent Claims may exist for which a Letter of Assurance has not been received. The IEEE is not responsible for identifying Essential Patent Claims for which a license may be required, for conducting inquiries in
33、to the legal validity or scope of Patents Claims, or determining whether any licensing terms or conditions provided in connection with submission of a Letter of Assurance, if any, or in any licensing agreements are reasonable or non-discriminatory. Users of this standard are expressly advised that d
34、etermination of the validity of any patent rights, and the risk of infringement of such rights, is entirely their own responsibility. Further information may be obtained from the IEEE Standards Association. Copyright 2014 IEEE. All rights reserved. vi Participants At the time this IEEE standard was
35、completed, the oManual Working Group had the following membership: William Lumpkins, Chair Kyle Wiens, Vice Chair Timothy Asp Daniel Eisenman T. Nathan Nossal Robert Sanitate Mark Schaffer Cornelius Van Rensburg Daniel Wiens The following members of the individual balloting committee voted on this s
36、tandard. Balloters may have voted for approval, disapproval, or abstention. Timothy Asp Bill Brown Keith Chow Thomas Coughlin Daniel Eisenman Randall Groves Werner Hoelzl Yuri Khersonsky Michael Lauxman William Lumpkins Charles Ngethe Ulrich Pohl Iulian Profir Robert Sanitate Bartien Sayogo Mark Sch
37、affer Steven Smith Walter Struppler Kyle Wiens When the IEEE-SA Standards Board approved this standard on 11 December 2013, it had the following membership: John Kulick, Chair David J. Law, Vice Chair Richard H. Hulett, Past Chair Konstantinos Karachalios, Secretary Masayuki Ariyoshi Peter Balma Far
38、ooq Bari Ted Burse Wael William Diab Stephen Dukes Jean-Philippe Faure Alexander Gelman Mark Halpin Gary Hoffman Paul Houz Jim Hughes Michael Janezic Joseph L. Koepfinger* Oleg Logvinov Ron Petersen Gary Robinson Jon Walter Rosdahl Adrian Stephens Peter Sutherland Yatin Trivedi Phil Winston Yu Yuan
39、*Member Emeritus Also included are the following nonvoting IEEE-SA Standards Board liaisons: Richard DeBlasio, DOE Representative Michael Janezic, NIST Representative Julie Alessi IEEE-SA Content Publishing Michael Kipness IEEE-SA Technical Community Programs Copyright 2014 IEEE. All rights reserved
40、. vii Introduction This introduction is not part of IEEE Std 1874-2013, IEEE Standard for Documentation Schema for Repair and Assembly of Electronic Devices. Manuals have always included images, parts diagrams, and references to other documents. Those links and metadata are a significant part of wha
41、t makes a manual effective. The Internet is perfect for making these documents come alive, making it possible to connect guides with tools and reference specifications. Currently, the vast majority of manuals distributed online do not take advantage of this flexibility. Most dictionaries have defini
42、tions of manuals as referring to instruction books. The working definition for this standard is: A manual is a document that teaches you how to do something. To pick a few examples, oManual is a good fit for reference manuals, instruction manuals, user manuals, owners manuals, how-to manuals, surviv
43、al guides, and service manualsbut thats just a start. A huge amount of useful data in existing formats is in static documents where it cannot be leveraged, built upon, and repurposed. oManual is a standard for exchanging and maintaining procedural manuals across diverse systems that solves this prob
44、lem. Publishing manuals as user friendly oManual files allows for the best of both worlds: manuals that retain their ease of use, but are also easy to maintain and build upon. oManual is optimized for the creation and exchange of procedural manuals. It is intended for use by anyone who wants to publ
45、ish manuals, whether they are repair manuals, manuals to create things, manuals to recycle things, how-to guides, work instructions, or any other type of manual which contains step by step instructions. oManual is designed for developers who want a flexible format that allows them to republish conte
46、nt in new ways. Since documentation exists in many formatsPDFs, Word documents, and specialized formats like DITAbut often lives on a single computer, establishing a single, accurate source for these documents requires complex document management systems. Accessing these (often very large) documents
47、 from a mobile device can be challenging because it requires downloading the entire file up front. Mobile applications usually download information as they need it, from an on-demand API. oManual bridges these two worlds by providing a common data format, and allowing the information to be transmitt
48、ed via legacy offline files or made available as a web service. An example workflow would be to take XML DITA service manuals, convert them to oManual with an XSLT transform, and then load them onto a JSON server for use by mobile applications. Copyright 2014 IEEE. All rights reserved. viii Contents
49、 1. Overview 1 1.1 Scope . 1 1.2 Purpose 1 2. Normative references 2 3. Definitions and acronyms . 2 3.1 Definitions . 2 3.2 Acronyms 3 4. Manual format 3 5. Documentation . 4 5.1 Data specification 4 5.2 Transmission formats .18 6. Query parameters.19 7. XSD .20 7.1 oManual category XSD 20 7.2 oManual guide XSD .23 7.3 oManual simplified HTML XSD 30 Copyright 2014 IEEE. All rights reserved. 1 IEEE Standard for Documentation Schema for Repair and Assembly of Electronic Devices IMPORTANT NOTICE: IEEE Standards documents are not intended to ensure safety, security,
