Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to include another CSL? #242

Closed
adebali opened this issue Jul 2, 2019 · 7 comments · Fixed by #245
Closed

How to include another CSL? #242

adebali opened this issue Jul 2, 2019 · 7 comments · Fixed by #245

Comments

@adebali
Copy link
Contributor

adebali commented Jul 2, 2019

I wasn't able to find in the documents how I can implement another CSL file to render my references based on some specific requirements.

I think modifying the line CSL_PATH=build/assets/style.csl in build.sh is the way. Is there an easier way without changing build.sh?

@dhimmel
Copy link
Member

dhimmel commented Jul 2, 2019

Our current recommendation is to edit the line in build.sh:

CSL_PATH=build/assets/style.csl

You should be able to point this at a URL. You can find available styles at https://github.com/citation-style-language/styles or https://www.zotero.org/styles. If using a style from GitHub, make sure to replace blob with raw in the URL to get the raw file as opposed to the HTML page. See greenelab/meta-review@41a257f for an example.

You can also edit build/assets/style.csl, but I'd only recommend this for small edits. You could also make a new local file like build/assets/custom-style.csl and then change build.sh to point at this.

@agitter
Copy link
Member

agitter commented Jul 2, 2019

Let's add these instructions to USAGE.md.

We may also want to revisit #189 to discuss longer term plans for customizing the build process (CSL, plugins, etc.) through a config file, environment variables, or something else that is less technical than editing a bash script.

@ben-heil
Copy link

ben-heil commented Mar 4, 2023

For any future Manubot users who came here because this is the top Google result for "Manubot CSL", this fix is no longer valid. The updated method for changing CSL files can be found here: #334 (comment)

tl;dr go to build/pandoc/defaults/common.yaml and update the csl field there

@agitter
Copy link
Member

agitter commented Mar 5, 2023

Thanks @ben-heil.

To help keep this issue future proof in case the behavior changes again, we also describe the way to do this in the "Custom formatting" section of USAGE.md, which is available here.

@lubianat
Copy link
Contributor

@agitter as a note here, the manifesto "USAGE.md" is outdated, and still points to build.sh:
https://github.com/manubot/manufesto/blob/master/USAGE.md

@agitter
Copy link
Member

agitter commented May 16, 2023

the manifesto "USAGE.md" is outdated, and still points to build.sh:

That's because the manufesto paper is using a very old version of rootstock. It looks like it hasn't been updated since 2019. I could update it but will need to wait until I can set aside some time to resolve merge conflicts.

@dhimmel
Copy link
Member

dhimmel commented May 16, 2023

Ah I can also update manufesto. I expect the underlying issue here is that @lubianat googled something like "manubot usage github" and the rootstock USAGE is not even listed on the first page! I wonder why.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants