Git Product home page Git Product logo

xsd-doc-tools's Introduction

Metanorma XSD documentation tools

Purpose

This repository demonstrates how to generate documentation directly from XSD.

Prerequisites

Generation of XSD documentation depends on the following tools:

Usage

Annotation

Documentation is entered into the XSD file using the <xsd:annotation> and <xsd:documentation> tags.

e.g.

<schema
  xmlns="http://www.w3.org/2001/XMLSchema"
  xmlns:cit="http://standards.iso.org/iso/19115/-3/cit/1.0"
  targetNamespace="http://standards.iso.org/iso/19110/gfc/1.1" version="1.1">
	<!-- =========================== Annotation ============================== -->
	<xs:annotation>
		<xs:documentation>
      ### Description

      GFC 1.1 is an XML Schema implementation derived from ISO ISO 19110,
      Geographic information -- Methodology for feature cataloguing. It includes
      ...
		<xs:documentation>
	<xs:annotation>

Generation

Command to generate documentation under docs/:

make docs
Note
This command will download all necessary dependencies under .archives/ and place them in corresponding paths.

Adopting the system

Copy the Makefile and adopt it to your project.

Examples

Documentation created from these tools can be seen at:

License

Copyright Ribose.

xsd-doc-tools's People

Contributors

intelligent2013 avatar ronaldtse avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.