diff --git a/docs/authoring/front-matter.qmd b/docs/authoring/front-matter.qmd index e88ebbe469..872901b5c7 100644 --- a/docs/authoring/front-matter.qmd +++ b/docs/authoring/front-matter.qmd @@ -145,8 +145,7 @@ author: #### Name Components -Quarto will automatically parse the `name` key into its components. -However, if this parsing is incorrect you can specify the components, `given`, `family`, `dropping-particle`, and `non-dropping-particle` directly, for example: +Quarto will automatically parse the `name` key into its components. However, if this parsing is incorrect you can specify the components, `given`, `family`, `dropping-particle`, and `non-dropping-particle` directly, for example: ``` yaml --- @@ -162,11 +161,11 @@ author: --- ``` -#### Degrees +#### Degrees You may specify degrees or academic titles using the `degrees` field of authors: -```yaml +``` yaml author: - name: Josiah Carberry degrees: @@ -184,8 +183,7 @@ author: roles: "Conceived and designed the study, analysed the results and wrote the manuscript." ``` -Or alternatively, make use of the [Contributor Roles Taxonomy (CRediT)](https://credit.niso.org). -To use CRediT roles provide one of the [14 contributor](#credit-roles) roles, e.g.: +Or alternatively, make use of the [Contributor Roles Taxonomy (CRediT)](https://credit.niso.org). To use CRediT roles provide one of the [14 contributor](#credit-roles) roles, e.g.: ``` yaml author: @@ -202,7 +200,8 @@ author: ``` Or specify the role along with a degree of contribution: -```yaml + +``` yaml author: - name: Josiah Carberry roles: @@ -210,34 +209,44 @@ author: - data curation: supporting ``` -::: {.callout-tip collapse="true" #credit-roles} - +::: {#credit-roles .callout-tip collapse="true"} ## Expand to see the 14 Contributor Roles -| Value | Alias | -|----------------------------------------------------|----------| -| [conceptualization](https://credit.niso.org/contributor-roles/conceptualization/) | | -| [data curation](https://credit.niso.org/contributor-roles/data-curation/) | | -| [formal analysis](https://credit.niso.org/contributor-roles/formal-analysis/) | analysis | -| [funding acquisition](https://credit.niso.org/contributor-roles/funding-acquisition/) | funding | -| [investigation](https://credit.niso.org/contributor-roles/investigation/) | | -| [methodology](https://credit.niso.org/contributor-roles/methodology/) | | -| [project administration](https://credit.niso.org/contributor-roles/project-administration/) | | -| [resources](https://credit.niso.org/contributor-roles/resources/) | | -| [software](https://credit.niso.org/contributor-roles/software/) | | -| [supervision](https://credit.niso.org/contributor-roles/supervision/) | | -| [validation](https://credit.niso.org/contributor-roles/validation/) | | -| [visualization](https://credit.niso.org/contributor-roles/visualization/) | | -| [writing – review & editing](https://credit.niso.org/contributor-roles/writing-review-editing/) | editing | -| [writing – original draft](https://credit.niso.org/contributor-roles/writing-original-draft/) | writing | - -: CRediT contributor values available in `roles` - - - ++-------------------------------------------------------------------------------------------------+-------------+ +| Value | Alias | ++=================================================================================================+=============+ +| [conceptualization](https://credit.niso.org/contributor-roles/conceptualization/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [data curation](https://credit.niso.org/contributor-roles/data-curation/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [formal analysis](https://credit.niso.org/contributor-roles/formal-analysis/) | analysis | ++-------------------------------------------------------------------------------------------------+-------------+ +| [funding acquisition](https://credit.niso.org/contributor-roles/funding-acquisition/) | funding | ++-------------------------------------------------------------------------------------------------+-------------+ +| [investigation](https://credit.niso.org/contributor-roles/investigation/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [methodology](https://credit.niso.org/contributor-roles/methodology/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [project administration](https://credit.niso.org/contributor-roles/project-administration/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [resources](https://credit.niso.org/contributor-roles/resources/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [software](https://credit.niso.org/contributor-roles/software/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [supervision](https://credit.niso.org/contributor-roles/supervision/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [validation](https://credit.niso.org/contributor-roles/validation/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [visualization](https://credit.niso.org/contributor-roles/visualization/) | | ++-------------------------------------------------------------------------------------------------+-------------+ +| [writing – review & editing](https://credit.niso.org/contributor-roles/writing-review-editing/) | editing | ++-------------------------------------------------------------------------------------------------+-------------+ +| [writing – original draft](https://credit.niso.org/contributor-roles/writing-original-draft/) | writing | ++-------------------------------------------------------------------------------------------------+-------------+ + +: CRediT contributor values available in `roles` ::: - ### Affiliation {#affiliation} Like `author`, you can provide a string is directly to `affiliation`, as in: @@ -263,25 +272,24 @@ author: In addition to `name`, `affiliation` can take any of the following: -+-------------------------+-----------+----------------------------------------------------------------------------------------------------+ -| `department` | String | | -+-------------------------+-----------+----------------------------------------------------------------------------------------------------+ -| `group` | String | Team or research group within the affiliation | -+-------------------------+-----------+----------------------------------------------------------------------------------------------------+ -| `address`\ | String | Affiliation's location. Provide one of `region` or `state`, and any combination of the other keys. | -| `city`\ | | | -| `region` or `state`\ | | | -| `country`\ | | | -| `postal-code` | | | -+-------------------------+-----------+----------------------------------------------------------------------------------------------------+ -| `url` | String | Affiliation's website. Converted to a link in many formats. | -+-------------------------+-----------+----------------------------------------------------------------------------------------------------+ -| \ | \ | Affiliation IDs:\ | -| `isni`\ | Numeric\ | 16 digit [International Standard Name Identifier (ISNI)](https://isni.org/); \ | -| `ringgold`\ | Numeric\ | 4-6 digit [Ringgold ID](https://www.ringgold.com/ringgold-identifier/);\ | -| `ror` | String | [Research Organization Registry (ROR) ID](https://ror.org/), starting with `https://ror.org/`, | -| | | followed by a 9 digit alphanumeric identifier. | -+-------------------------+-----------+----------------------------------------------------------------------------------------------------+ ++----------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| `department` | String | | ++----------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| `group` | String | Team or research group within the affiliation | ++----------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| `address`\ | String | Affiliation's location. Provide one of `region` or `state`, and any combination of the other keys. | +| `city`\ | | | +| `region` or `state`\ | | | +| `country`\ | | | +| `postal-code` | | | ++----------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| `url` | String | Affiliation's website. Converted to a link in many formats. | ++----------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| \ | \ | Affiliation IDs:\ | +| `isni`\ | Numeric\ | 16 digit [International Standard Name Identifier (ISNI)](https://isni.org/);\ | +| `ringgold`\ | Numeric\ | 4-6 digit [Ringgold ID](https://www.ringgold.com/ringgold-identifier/);\ | +| `ror` | String | [Research Organization Registry (ROR) ID](https://ror.org/), starting with `https://ror.org/`, followed by a 9 digit alphanumeric identifier. | ++----------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------+ : Available keys to `affiliation` @@ -475,21 +483,23 @@ The Creative Commons copyright licenses and tools forge a balance inside the tra Here are some of the common forms of Creative Commons content license: -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| License | Name | Description | -+===============+=========================================+=======================================================================================================================================================================================================================================================================================================================================================================================+ -| `CC BY` | Attribution | This license lets others distribute, remix, tweak, and build upon your work, even commercially, as long as they credit you for the original creation. This is the most accommodating of licenses offered. | -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `CC BY-SA` | Attribution-ShareAlike | This license lets others remix, tweak, and build upon your work even for commercial purposes, as long as they credit you and license their new creations under the identical terms. This license is often compared to "copyleft" free and open source software licenses. All new works based on yours will carry the same license, so any derivatives will also allow commercial use. | -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `CC BY-ND` | Attribution-NoDerivs | This license allows for redistribution, commercial and non-commercial, as long as it is passed along unchanged and in whole, with credit to you. | -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `CC BY-NC` | Attribution-NonCommercial | This license lets others remix, tweak, and build upon your work non-commercially, and although their new works must also acknowledge you and be non-commercial, they don't have to license their derivative works on the same terms. | -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `CC BY-NC-SA` | Attribution-NonCommercial-ShareAlike | This license lets others remix, adapt, and build upon your work non-commercially, as long as they credit you and license their new creations under the identical terms. | -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `CC BY-NC-ND` | Attribution-NonCommercial-NoDerivs | This license is the most restrictive of the six main licenses, only allowing others to download your works and share them with others as long as they credit you, but they can't change them in any way or use them commercially. | -+---------------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| License | Name | Description | ++===============+======================================+=======================================================================================================================================================================================================================================================================================================================================================================================+ +| `CC BY` | Attribution | This license lets others distribute, remix, tweak, and build upon your work, even commercially, as long as they credit you for the original creation. This is the most accommodating of licenses offered. | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `CC BY-SA` | Attribution-ShareAlike | This license lets others remix, tweak, and build upon your work even for commercial purposes, as long as they credit you and license their new creations under the identical terms. This license is often compared to "copyleft" free and open source software licenses. All new works based on yours will carry the same license, so any derivatives will also allow commercial use. | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `CC BY-ND` | Attribution-NoDerivs | This license allows for redistribution, commercial and non-commercial, as long as it is passed along unchanged and in whole, with credit to you. | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `CC BY-NC` | Attribution-NonCommercial | This license lets others remix, tweak, and build upon your work non-commercially, and although their new works must also acknowledge you and be non-commercial, they don't have to license their derivative works on the same terms. | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `CC BY-NC-SA` | Attribution-NonCommercial-ShareAlike | This license lets others remix, adapt, and build upon your work non-commercially, as long as they credit you and license their new creations under the identical terms. \| | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `CC BY-NC-ND` | Attribution-NonCommercial-NoDerivs | This license is the most restrictive of the six main licenses, only allowing others to download your works and share them with others as long as they credit you, but they can't change them in any way or use them commercially. | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `CC0` | | CC0 (aka CC Zero) is a public dedication tool, which enables creators to give up their copyright and put their works into the worldwide public domain. CC0 enables reusers to distribute, remix, adapt, and build upon the material in any medium or format, with no conditions. | ++---------------+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ If you specify a Creative Commons license for your content, Quarto will automatically include the relevant link to the appropriate license. @@ -528,4 +538,4 @@ funding: investigator: - ref: nj --- -``` +``` \ No newline at end of file