Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create metanorma-plugin-oscal for parsing and accessing OSCAL content #1

Open
ronaldtse opened this issue Mar 20, 2023 · 3 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link

As described in lutaml/oscal#2 .

The implementation of this gem will be similar to that of metanorma-plugin-glossarist.

@ronaldtse ronaldtse added the enhancement New feature or request label Mar 20, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Metanorma Mar 20, 2023
@ronaldtse ronaldtse moved this from 🆕 New to 🌋 Urgent in Metanorma Mar 20, 2023
@ronaldtse
Copy link
Author

From these two documents we need to come up with some good "macros" such that people can use them to render OSCAL content.

@HassanAkbar
Copy link
Member

@ronaldtse From what I understand we would require the following for OSCAL plugin

  • If there is a key named params in oscal.yaml file then we will use that to fill the inserts directives in the yaml file as mentioned here
  • Block directives something like we have in metanorma-plugin-glossarist
    • [oscal, <file name>, <context name>]
  • Dataset Directives
    • :oscal-dataset: <dataset name>:<file_name>

For reading the OSCAL data from yaml files we can use https://github.com/metanorma/oscal-ruby gem.

Did I get this right or do we need to do something else?

@ronaldtse
Copy link
Author

@HassanAkbar sorry for the late reply on this one. Yes this is correct.

We should however update the oscal-ruby gem first for this issue:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🌋 Urgent
Development

No branches or pull requests

2 participants