Pkgdown: Provide way to override title of home page

[hadley]

Since package title might not always be appropriate (since CRAN might require quoting)

[maelle]

Ah something else I'd like to see implemented! Would it be ok to make it work via a title field of the config?

Then in data_home()

pagetitle = pkg$desc$get("Title")[[1]]

could become

pagetitle = pkg$meta[["title"]] %||% pkg$desc$get("Title")[[1]]

?

If so I can make a PR.

[jayhesselberth]

Yes, that looks like the right change. Can you make a PR?

[maelle]

Will do, will just wait for my other PR to be merged in order to have learned lessons and not make the same mistakes twice! :-)

[maelle]

This has to be re-opened cf https://github.com/r-lib/pkgdown/pull/1005#issuecomment-492178755: my implementation used a param name that was already used for something else, so I've opened a PR removing my changes as requested by @jayhesselberth.

[hadley]

I suggest we make it a subcomponent of home:

home:
  title: "This is my package title"

[maelle]

So there would be a "general" title and a title under home, correct?

[hadley]

@maelle do you want to take another stab at this?

[hadley]

Yes exactly (sorry for out of order reply)

[maelle]

Yep, will try to next week!

[maelle]

Btw would a similar parameter for "og:description" make sense? The Description field from DESCRIPTION also contains quotes.

[maelle]

I mean tweaking

opengraph = list(description = pkg$desc$get("Description")[[1]])

into

opengraph = list(description = pkg$meta$home[["description"]] %||% pkg$desc$get("Description")[[1]])

I can open a separate issue (or add that to my open PR) if of interest.

[hadley]

Is that used on every page or just the home page?

[maelle]

Just the homepage I think

https://github.com/r-lib/pkgdown/blob/9800c853e1c85a18990cdd694f1adf9dd1739a55/R/build-articles.R#L178

https://github.com/r-lib/pkgdown/blob/72391933f693e1d9509edade4951486883d64382/R/build-reference.R#L229

[hadley]

Great — please wrap that up into your PR too.

[maelle]

Would it be too extreme for pkgdown to unquote all quoted words of Title and Description (uncranify them) by default? Only for the ' quotes. Users might still want to use the home fields in config for more customization (or to requote words). 🤔

[hadley]

Oh yes, that's a good idea!

[maelle]

In a separate PR or the same?

[hadley]

I think it can be in the same PR since it's going to touch the same code.