Is there an example of what editor does in the book yml as opposed to author?

[philmcaleer]

Description

We are writing an online book through quarto and whilst the yml option of author works fine and presents the authors under the title of the book on the landing page, the editor option seems not to present anything (or I at least can't get it working). The issue being we are editors of the book and not sole authors so editors would be a better represenation.

For example the below would work fine and produce my name under the title as the author

---
book:
  title: "Scholarship of Teaching and Learning Compendium"
  author: 
   - orcid: 0000-0000-0000-0000
    name:
      family: McAleer
      given: Phil
---

However the below seems to not show my name at all and I am not sure

---
book:
  title: "Scholarship of Teaching and Learning Compendium"
  editor: "Phil McAleer"
---

This also doesn't seem to show my name. At least not as far as I can see:

---
book:
  title: "Scholarship of Teaching and Learning Compendium"
  editor: 
   - orcid: 0000-0000-0000-0000
    name:
      family: McAleer
      given: Phil
---

Any guidance or worked example would be super appreciated!

[mcanouil]

All your examples are not valid YAML.
book is a project level option so it lives in _quarto.yml thus there should not have any --- in it.
Your items are also not properly indented which can lead to issues.

Please provide a small fully reproducible example, for example using quarto create project book and sharing the result as a Git repository.

---

From what I understand, editor is a sub-key of citation which is not a Book project option and is not used in any templates as far as I know: https://quarto.org/docs/authoring/create-citeable-articles.html#web-articles

So, unless you use custom templates/partials to use it, I don't see why it would show up anywhere.

By the way, where did you see editor option? (not the top-level editor option which control the behaviour of the editor such as VSCode, Positron, and RStudio).

[philmcaleer]

Thanks for replying @mcanouil, I am not sure I quite follow the first part but let me try :-)

I gave a truncated version of the _quarto.yml we have in our repository which is here if that helps: https://github.com/BartlettJE/sotl_glossary/blob/main/_quarto.yml

The book is rendering fine with the author approach I showed first but the editor approach doesn't change anything, and as you say I can't see any examples.

All that said, it might be you are right and it isn't part of the options, I was reading this section here: https://quarto.org/docs/reference/projects/books.html#section which seemed to suggest it was but maybe that is my bad reading.

Thanks for any info you can give.

[mcanouil]

Here:

- ---
book:
  title: "Scholarship of Teaching and Learning Compendium"
  author: 
   - orcid: 0000-0000-0000-0000
-   name:
-     family: McAleer
-     given: Phil
+    name:
+      family: McAleer
+      given: Phil
- ---

[mcanouil]

The references pages are generated automatically based on the schema since book project share most with website project, it's not impossible there are "misplaced" options.
Anyhow, "editor", "doi", "abstract-url", etc. are options to fill in the "reference" of the book: https://quarto.org/docs/authoring/create-citeable-articles.html

This is the "csl-item-shared": https://github.com/quarto-dev/quarto-cli/blob/main/src/resources/schema/definitions.yml#L1747

Which is part of book:

• quarto-cli/src/resources/schema/project.yml

  Lines 59 to 66 in b19f1e1

  	- name: book
  	description: Book configuration.
  	schema:
  	object:
  	super:
  	- resolveRef: book-schema
  	- resolveRef: csl-item-shared

This was added in 1.2: #2418

• Using metadata under book key cannot be referenced anymore #2148

Book support the CSL entries since then but there is no documentation I can find to what purpose it serves as it's not even used anywhere in the generated formats.

I think the only purpose is to allow access to write custom partials/templates using book.XXXX entries. (Although to have the citation feature work for book would be great in my opinion)

@cscheid @cderv as you were involved in this early change, maybe you know more.