IEEE P3335 TimeCard Specification

This repository contains the working draft source for the IEEE P3335 TimeCard Specification. It defines the architectural framework, performance expectations, and interoperability objectives for TimeCard devices--modular timing subsystems that provide standardized, high-precision time, phase, and frequency services to host systems.

Project Structure

The text is organized by clause, with each clause having its own dedicated folder. Inside each folder, a README.md file serves as the current draft source for that clause.

Other files (such as references, diagrams, or unstructured notes) may exist in these folders, but they are not considered part of the normative or informative text unless explicitly included or referenced within the chapter's respective README.md file.

Active Draft Sources

Clause / Annex	Source
Front matter	00 - Front Matter/README.md
1. Overview	01 - Overview/README.md
2. Normative References	02 - Normative References/README.md
3. Definitions, Acronyms, and Abbreviations	03 - Definitions, Acronyms and Abbreviations/README.md
4. Conformance	04 - Conformance/README.md
5. Architecture	05 - Architecture/README.md
6. Performance Specifications	06 - Performance Specifications/README.md
7. Timing Interfaces	07 - Timing Interfaces/README.md
8. Control Interfaces	08 - Control Interfaces/README.md
9. Environment	09 - Environment/README.md
10. Applications and Best Practices	10 - Applications and Best Practices/README.md
Annex A. Metrics	Annex A - Metrics/README.md
Annex B. Test Procedures	Annex B - Test Procedures/README.md
Annex C. Bibliography	Annex C - Bibliography/README.md
Annex D. Conformance Statement Proforma	Annex D - Conformance Statement Proforma/README.md

The Unsorted/ directory is an archival working area for source contributions, extracted presentations, older material, and background notes. It is useful for editorial research but is not automatically included in the compiled draft.

Building the Standard

The complete specification can be compiled from all of the individual clause README.md files into a single, unified PDF document.

Requirements

You will need to have Pandoc and a LaTeX distribution (such as MacTeX or TeX Live) installed to perform the build. Specifically, the build utilizes the xelatex PDF engine to handle Unicode symbols seamlessly.

Build Instructions

A Makefile is provided at the root of the repository to automate compiling the document.

To run editorial and traceability checks:

make check

To generate the complete draft:

make

This command will:

1. Dynamically find the front matter, all 01 through 10 clauses, and all annex README.md files.
2. Sort them numerically and alphabetically.
3. Pass them logically to pandoc.
4. Add pagewise review line numbers to every text line from the Abstract onward.
5. Add the current build date to the footer of every page.
6. Output a single table-of-contents included document called IEEE3335.pdf at the root directory.

To remove the generated PDF and clean up the build output:

make clean

Publication Readiness

See PUBLICATION_READINESS.md for the current editorial gap matrix, remaining working-group decisions, and recommended next actions before IEEE SA publication processing.

Supporting readiness artifacts:

• references/P3335_PAR_SCOPE_PURPOSE.md records the public PAR scope and purpose trace used for Clause 1.
• references/NORMATIVE_REFERENCE_AUDIT.md records the current Clause 2 reference audit.
• figures/ contains source-controlled figure sources and rendered assets used by the draft.
• REQUIREMENTS_INDEX.md is generated from normative clauses with python3 scripts/requirements_index.py.