martiLQ/docs/source/samples/json/sample_04.md

6.8 KiB

Sample with entire directory

The sample martiLQ document below has been generated using the client GOLANG program and including all files in a folder and child folders and matching the filter.

The source is the project folder /docs/source and default configuration has been used.

This sample demonstrates the use of filters to select what files to include.

GOLANG program arguments are :

-t GEN -m test_Sample04.json -s docs/source/ --title "GEN004" --description "Directory example with filter" -R --filter "^[r|R].*\.md"

The martiLQ document

{
    "contentType": "application/vnd.martilq.json",
    "title": "GEN004",
    "uid": "207096a1-aac1-4b66-9748-707f07b63691",
    "description": "Directory example with filter",
    "modified": "2021-11-03T22:02:42.8874753+11:00",
    "publisher": "",
    "contactPoint": "",
    "accessLevel": "",
    "rights": "",
    "tags": null,
    "license": "",
    "state": "",
    "batch": 0,
    "describedBy": "",
    "landingPage": "",
    "theme": "",
    "resources": [
        {
            "title": "README.md",
            "uid": "a3035230-d2b3-4157-87db-0e65df433686",
            "documentName": "README.md",
            "issueDate": "2021-11-03T22:02:42.8815605+11:00",
            "modified": "2021-11-01T22:33:07.3888826+11:00",
            "expires": "2028-11-03T00:00:00+11:00",
            "state": "active",
            "author": "",
            "length": 1566,
            "hash": {
                "algo": "SHA256",
                "value": "cf7cbf4186779984144fd022f4ba77b9773ffdc799b4a87f74e0ad2c52a7a261",
                "signed": false
            },
            "description": "",
            "url": "file://README.md",
            "version": "",
            "contentType": "",
            "encoding": "UTF-8",
            "compression": "",
            "encryption": "",
            "describedBy": "",
            "attributes": [
                {
                    "category": "dataset",
                    "name": "records",
                    "function": "count",
                    "comparison": "EQ",
                    "value": "43"
                }
            ]
        },
        {
            "title": "references.md",
            "uid": "5e64cb84-bcb3-4002-9863-c2f5f8c4a29c",
            "documentName": "references.md",
            "issueDate": "2021-11-03T22:02:42.883191+11:00",
            "modified": "2021-11-01T23:25:15.048493+11:00",
            "expires": "2028-11-03T00:00:00+11:00",
            "state": "active",
            "author": "",
            "length": 722,
            "hash": {
                "algo": "SHA256",
                "value": "659db48c3b80a7c1ca3443fc43c45fe76eaa09c151e15f4dc1825fc84653f065",
                "signed": false
            },
            "description": "",
            "url": "file://references.md",
            "version": "",
            "contentType": "",
            "encoding": "UTF-8",
            "compression": "",
            "encryption": "",
            "describedBy": "",
            "attributes": [
                {
                    "category": "dataset",
                    "name": "records",
                    "function": "count",
                    "comparison": "EQ",
                    "value": "24"
                }
            ]
        },
        {
            "title": "resources.md",
            "uid": "42632c8d-bd18-4c3f-9daa-5873fb547f8d",
            "documentName": "resources.md",
            "issueDate": "2021-11-03T22:02:42.883191+11:00",
            "modified": "2021-11-01T23:23:55.517501+11:00",
            "expires": "2028-11-03T00:00:00+11:00",
            "state": "active",
            "author": "",
            "length": 4646,
            "hash": {
                "algo": "SHA256",
                "value": "d2918d7b373a8b3bf43f377bc3d8df21f623b3c2a61bf5a16e19602fa763b8fc",
                "signed": false
            },
            "description": "",
            "url": "file://resources.md",
            "version": "",
            "contentType": "",
            "encoding": "UTF-8",
            "compression": "",
            "encryption": "",
            "describedBy": "",
            "attributes": [
                {
                    "category": "dataset",
                    "name": "records",
                    "function": "count",
                    "comparison": "EQ",
                    "value": "98"
                }
            ]
        },
        {
            "title": "README.md",
            "uid": "66623c75-f9fe-4138-bc3c-979f176dfe19",
            "documentName": "README.md",
            "issueDate": "2021-11-03T22:02:42.8842642+11:00",
            "modified": "2021-10-09T08:14:26.6966073+11:00",
            "expires": "2028-11-03T00:00:00+11:00",
            "state": "active",
            "author": "",
            "length": 67,
            "hash": {
                "algo": "SHA256",
                "value": "85c4bc066e7a0a2dd9098fa1f58e05e741489d014064b2e58b6602115a12e5af",
                "signed": false
            },
            "description": "",
            "url": "file://samples/README.md",
            "version": "",
            "contentType": "",
            "encoding": "UTF-8",
            "compression": "",
            "encryption": "",
            "describedBy": "",
            "attributes": [
                {
                    "category": "dataset",
                    "name": "records",
                    "function": "count",
                    "comparison": "EQ",
                    "value": "4"
                }
            ]
        },
        {
            "title": "README.md",
            "uid": "d661a0c3-fcf4-48f1-aee6-bdb28f996515",
            "documentName": "README.md",
            "issueDate": "2021-11-03T22:02:42.8847953+11:00",
            "modified": "2021-11-03T00:04:54.642+11:00",
            "expires": "2028-11-03T00:00:00+11:00",
            "state": "active",
            "author": "",
            "length": 284,
            "hash": {
                "algo": "SHA256",
                "value": "59717266e6cd617cece0c4104e620ec62dbc816042f58f0b212adb954a14a83b",
                "signed": false
            },
            "description": "",
            "url": "file://samples/json/README.md",
            "version": "",
            "contentType": "",
            "encoding": "UTF-8",
            "compression": "",
            "encryption": "",
            "describedBy": "",
            "attributes": [
                {
                    "category": "dataset",
                    "name": "records",
                    "function": "count",
                    "comparison": "EQ",
                    "value": "11"
                }
            ]
        }
    ],
    "custom": [
        {
            "extension": "software",
            "softwareName": "MARTILQREFERENCE",
            "author": "Meerkat@merebox.com",
            "version": "0.0.1"
        }
    ]
}