citation-style-language / documentation

Citation Style Language documentation
http://citationstyles.org/
Creative Commons Attribution Share Alike 4.0 International
43 stars 21 forks source link

Describe item types #84

Closed bwiernik closed 4 years ago

bwiernik commented 4 years ago

I started to write item type descriptions, including some specific special considerations where needed (cf. http://mirrors.ibiblio.org/CTAN/macros/latex/contrib/biblatex/doc/biblatex.pdf). In progress. My thought was to write a bunch of examples so that we could discuss format and style. Once we've agreed on that, we could either merge or add more to this PR (e.g., we could finish documenting all of the existing item types in 1.0.1, then add new item types in future PRs).

Closes https://github.com/citation-style-language/documentation/issues/70

bwiernik commented 4 years ago

@adam3smith What do you think of the description of article for preprints, working papers, etc.? I modeled it on CrossRef's description. I think there is potentially value in saying that a paper a researcher just throws onto their website is a manuscript rather than a preprint.

bdarcus commented 4 years ago

Looks like a great start; I'll look more closely when you turn off draft.

bwiernik commented 4 years ago

Thanks! Yeah, didn’t do any proofreading on these yet (wanted to get something up before @denismaier and I duplicated effort)

denismaier commented 4 years ago

Thanks for starting this! I think that looks really good so far. (Also the plan, 1.0.1. first, then new item types as we go along.)

bwiernik commented 4 years ago

If anyone wants to add missing descriptions as line comments like @adam3smith did, that would be great.

bdarcus commented 4 years ago

OK. It's explained here.

https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request

bwiernik commented 4 years ago

@bdarcus Are we good to merge this? I'll document the other new item types and variable after that.