A tool to process information in GDML(GDoc Markup Language) documents.

• NOW ON REFACTORING to release the first version.

1. I want to write software documents like follows.

   • Gdoc Architectural Design
   • PandocAST Detailed Design

   And to extract design information from documents and use it.
   for example, to display traceability information.

   $ gdoc trace --lower 3 OC3 docs/sample_ProjectManagement.md
   docs/sample_ProjectManagement.md:      ┌  SysML.Reqt AS.RA.PM.MAN3 - Project Management
   docs/sample_ProjectManagement.md:  ┌  @refine
   docs/sample_ProjectManagement.md:  │   ┌  SysML.Reqt ASPICE.3.1.MAN3.OC3 - [NOT FOUND]
   docs/sample_ProjectManagement.md:  ├  @copy
   docs/sample_ProjectManagement.md:  SysML.Reqt AS.RA.PM.OC3 - Outcome3: the activities and resources necessary to complete the work are sized and estimated;
   docs/sample_ProjectManagement.md:  └  @deriveReqt
   docs/sample_ProjectManagement.md:      ├  SysML.Reqt AS.RA.PM.BP4 - Define, monitor and adjust project activities.
   docs/sample_ProjectManagement.md:      │  └  @deriveReqt
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP4.1
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP4.2
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP4.3
   docs/sample_ProjectManagement.md:      │      └  SysML.Reqt AS.RA.PM.BP4.4
   docs/sample_ProjectManagement.md:      ├  SysML.Reqt AS.RA.PM.BP5 - Define, monitor and adjust project estimates and resources.
   docs/sample_ProjectManagement.md:      │  └  @deriveReqt
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP5.1
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP5.2
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP5.3
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP5.4
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP5.5
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP5.6
   docs/sample_ProjectManagement.md:      │      └  SysML.Reqt AS.RA.PM.BP5.7
   docs/sample_ProjectManagement.md:      ├  SysML.Reqt AS.RA.PM.BP6 - Ensure required skills, knowledge, and experience.
   docs/sample_ProjectManagement.md:      │  └  @deriveReqt
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP6.1
   docs/sample_ProjectManagement.md:      │      └  SysML.Reqt AS.RA.PM.BP6.2
   docs/sample_ProjectManagement.md:      ├  SysML.Reqt AS.RA.PM.BP8 - Define, monitor and adjust project schedule.
   docs/sample_ProjectManagement.md:      │  └  @deriveReqt
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP8.1
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP8.2
   docs/sample_ProjectManagement.md:      │      ├  SysML.Reqt AS.RA.PM.BP8.3
   docs/sample_ProjectManagement.md:      │      └  SysML.Reqt AS.RA.PM.BP8.4
   docs/sample_ProjectManagement.md:      └  SysML.Reqt AS.RA.PM.BP9 - Ensure consistency.
   docs/sample_ProjectManagement.md:         └  @deriveReqt
   docs/sample_ProjectManagement.md:             ├  SysML.Reqt AS.RA.PM.BP9.1
   docs/sample_ProjectManagement.md:             ├  SysML.Reqt AS.RA.PM.BP9.2
   docs/sample_ProjectManagement.md:             └  SysML.Reqt AS.RA.PM.BP9.3

   
   

2. Or, to create multi-purpose annotated documents with gdoc markup tags.

1. pandoc

   gdoc calls pandoc as subprocess. Install pandoc before using gdoc.

   gdoc can handle source-position attributes in pandoc AST json data. For this, pandoc version 2.11.3 or later is recommended.

   github.com/jgm/pandoc/issues/4565# Source mapping in AST:
   For anyone passing by this thread, this feature got released in 2.11.3

2. python3

   gdoc uses v3 standard libraries.

1. download or clone gdoc anywhere you want.
2. add execution path to 'gdoc/bin'.

$ gdoc -v

$ gdoc trace --lower 3 OC3 docs/sample_ProjectManagement.md