pub-gen-schema.json

It's the main schema of a publication created by pub-gen. Describes the data structure of the document being generated, extends the data-package.json, so it has all its properties and adds some specific to pub-gen.

PubGen

type object with properties

Description: Configuration file for pub-gen

Name	Type	Description	Required
name	string	An identifier for the publication. It will be automatically generated.	Yes
version	string	Version of the configuration file.	Yes
type	string	Type of the publication.	Yes
year	string	Publication year.	Yes
languages	array<string>	The languages of the publication. Use ISO 639-1 code.	No
drive	[Google Drive folder](#google drive folder)	Folder where the files will be synced.	No
profile	string	The profile of this descriptor.	No
id	string	A property reserved for globally unique identifiers. Examples of identifiers that are unique include UUIDs and DOIs.	No
title	string	A human-readable title.	No
description	string	A text description. Markdown is encouraged.	No
homepage	string	The home on the web that is related to this data package.	No
created	string	The datetime on which this descriptor was created.	No
contributors	Contributors	The contributors to this descriptor.	No
keywords	array<string>	A list of keywords that describe this package.	No
image	string	A image to represent this package.	No
licenses	array<License>	The license(s) under which this package is published.	No
resources	array<Data Resource>	An array of Data Resource objects, each compliant with the Data Resource specification.	No
sources	array<Source>	The raw sources for this resource.	No

---

Google Drive folder

type object with properties

Description: Folder where the files will be synced.

Name	Type	Description	Required
url	string	URL da pasta	No
id	string	ID da pasta	No

---

Contributors

type array<Contributor>

Description: The contributors to this descriptor.

Back to top

---

---

Contributors

type array<Contributor>

Description: The contributors to this descriptor.

Examples

"{\n  \"contributors\": [\n    {\n      \"title\": \"Joe Bloggs\"\n    }\n  ]\n}\n"

"{\n  \"contributors\": [\n    {\n      \"title\": \"Joe Bloggs\",\n      \"email\": \"joe@example.com\",\n      \"role\": \"author\"\n    }\n  ]\n}\n"

---

---