NISO STS 1.0 IEC/ISO Coding Guidelines
Total Page:16
File Type:pdf, Size:1020Kb
NISO STS 1.0 IEC/ISO Coding Guidelines Table of Contents 1 Maintenance ........................................................................................................................................................................... 7 2 Legal Terms ............................................................................................................................................................................ 7 3 General ...................................................................................................................................................................................... 7 3.1 Scope of this document ............................................................................................................................................ 7 3.2 Coding Guidance .......................................................................................................................................................... 7 3.3 Tagging differences between ISO and IEC ........................................................................................................ 8 3.4 Formatting of elements and attributes .............................................................................................................. 9 3.5 Multilingual documents ........................................................................................................................................... 9 4 Structure .................................................................................................................................................................................. 9 4.1 General ............................................................................................................................................................................ 9 4.2 Front matter ............................................................................................................................................................... 11 4.2.1 General................................................................................................................................................................ 11 4.2.2 Metadata ............................................................................................................................................................ 12 4.2.3 Foreword ........................................................................................................................................................... 14 4.2.4 Introduction ..................................................................................................................................................... 15 4.3 Body............................................................................................................................................................................... 17 4.3.1 General................................................................................................................................................................ 17 4.3.2 Clauses ................................................................................................................................................................ 17 4.3.3 Types of clause ................................................................................................................................................ 19 4.4 Back matter ................................................................................................................................................................ 24 4.4.1 General................................................................................................................................................................ 24 4.4.2 Annexes .............................................................................................................................................................. 24 4.4.3 Bibliography ..................................................................................................................................................... 26 4.4.4 Index .................................................................................................................................................................... 30 4.4.5 Footnotes ........................................................................................................................................................... 31 5 Content ................................................................................................................................................................................... 32 5.1 Spaces, punctuation and formatting ................................................................................................................ 32 5.2 Using <label> and <title> ...................................................................................................................................... 33 5.3 Using <p> .................................................................................................................................................................... 34 5.4 Symbols ........................................................................................................................................................................ 34 5.5 Formatting text with <styled-content> .......................................................................................................... 34 5.5.1 @style-type / @specific-use ........................................................................................................................ 34 5.5.2 @style .................................................................................................................................................................. 37 5.6 Notes and examples ................................................................................................................................................ 37 NISO STS 1.0 – IEC/ISO Coding Guidelines v. 1.0 / 2021-01-01 2 / 110 5.6.1 Notes in tables, figures and formulae .................................................................................................... 39 5.6.2 Notes with label “Warning / Important / Caution” ......................................................................... 40 5.7 Lists ............................................................................................................................................................................... 40 5.7.1 Lists with labels (ordered / unordered lists) ..................................................................................... 42 5.7.2 Lists without labels ....................................................................................................................................... 42 5.8 Specific text alignments ........................................................................................................................................ 43 5.9 Quotations .................................................................................................................................................................. 44 5.10 Graphics ....................................................................................................................................................................... 44 5.11 Boxed text ................................................................................................................................................................... 46 5.12 Code ............................................................................................................................................................................... 48 5.13 Preformatted text .................................................................................................................................................... 49 5.14 Editing instructions (deletions, additions) – IEC only .............................................................................. 49 6 Tables ..................................................................................................................................................................................... 50 6.1 General ......................................................................................................................................................................... 50 6.2 Table headers ............................................................................................................................................................ 51 6.3 Layout of content inside cells ............................................................................................................................. 52 6.4 Formal vs informal tables..................................................................................................................................... 52 6.5 Informal tables .......................................................................................................................................................... 53 6.6 Formal tables ............................................................................................................................................................. 53 6.6.1 General................................................................................................................................................................ 53 6.6.2 Designation ......................................................................................................................................................