citation-style-language/csl-editor

cslEditorLib - A HTML 5 library for searching and editing CSL styles

csl-editor's Issues

coordinate on contacting the CSL list

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-01-05 12:39:36

We should reach out to the CSL community mailing list. As Jeffrey says:

"
Wonderful! Is that something that you'd like to have posted to the list from your end in developer-speak (and since you've been following the list a lot longer than I have), or would you like me to draft something to send out? We could also roll this into the assessment piece at some point, but it seems like it might be good to let them know we're going to work on it."

Develop & Share Paper Layouts

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-08 20:15:33

paper layouts to describe flow, function of prototype website.

set up a github repo for this project.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 14:02:59
Parent issue: #5

As a user, I want a WYSIWYG editor so that I can manually edit the citation styles in Mendeley Desktop.

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-05 14:30:11

3964 votes on our feedback forum for this suggestion plus 300 comments
http://feedback.mendeley.com/forums/4941-mendeley-feedback/suggestions/80941-manually-edit-citation-styles-in-mendeley-desktop?ref=title

Milestone I: demo modification of existing styles

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-02-06 15:10:51

This is a placeholder task for a milestone

Blank issue - Sprintly importer

As a user, I want online storage for my styles so that I can access them from any computer, and can share Word documents using those styles with others.

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:17:18

Each style should have a resolvable URL which the Word processor plugins and ref managers could use to fetch the styles.

Privacy/security concern: I think keeping the styles accessible to anyone with the URL is best, so that Word documents are easily sharable, but probably restricting write access for a style to the author / admins.

NOTE: Would involve a bit of work in Mendeley Desktop to support this.

From Bruce: http://xbiblio-devel.2463403.n2.nabble.com/CSL-editor-td2618606.html

Where's the online integration? Please, please tell me you aren't
imagining users just creating and maintaining their own local styles.

Milestone II: Search styles

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 15:51:18

This is a placeholder for a milestone

As a developer, I want a list of functions for workflow so that I can develop wireframes.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-14 10:29:00

As a user, I want a tool to create citation styles for me based on example citations so that I don't have to deal with the complexity of the CSL style heirachy.

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:33:35

Devise clever CSL generation algorithm that would generate a CSL file which validates correctly against a suite of example citations (see #20).

Could utilize data in the existing respository and AI techniques.

More feasible for styles which are only slight variations on existing ones.

Related comment by Bruce on xbiblio:
Dan Stillman has more than once floated an interesting idea that users should be able to create a style that modifying some example output in place with a rich text editor.

As a user, I want additional citation styles so that Mendeley has the appropriate style for me to format my papers..

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-05 17:12:49

Add support for additional citation styles in Mendeley Desktop and Mendeley Web

681 votes on our feedback form: http://feedback.mendeley.com/forums/4941-mendeley-feedback/suggestions/80940-additional-citation-styles?ref=title

Commonly requested style additions-

ABNT, Brazilian styles: http://bit.ly/xBVXTe

Springer LNCS: http://bit.ly/ADWNIJ

PMCID for NIH Grant citation: http://bit.ly/zT1ZFg

IJMES : http://bit.ly/xjNBKB

As a user, I want a CSL search tool so that I can find an existing style which meets my requirements (or comes close).

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:43:56

Paraphrasing Carles on xbiblio:

1. Fuzzy search on style name/journal title
2. about 5 to 10 questions about style, (e.g. author/date or numbered) to narrow down search results
3. search by example citation

---

I've implemented a crude tool to do 3 already: https://github.com/SteveRidout/csl-editor

sumamrise xbiblio use cases up to 2012-01-24 as backlog stories in sprintly

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-01-24 16:55:47

As a developer, I want to read the CSL style specification so that I can understand what's going on.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-14 10:31:44

As a user, I want integration with citationstyles.org so that I can retrieve pre-existing citations and deposit modified citations..

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-01-19 15:51:38

Preliminary

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-14 10:29:51

This is a placeholder for preliminary items prior to beginning development work in Milestone I

As a developer, I want to see what other visual representations of XML exist so that I can gauge how others have represented XML.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-14 10:30:58

test a task that we will discard

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-20 18:23:33

As a user, I want to export styles in BibTex so that I can use LaTeX.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:33:40

set up a public wiki for the project

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 14:26:09

We want people to be able to feed back on the product process, so we
should have a wiki for the project.

• Ian

Allow multiple input citations in 'Search by Example'

Example use case:

User is using "Harvard" referencing format and are happy with the output except that they want a different sort order for inline citations in a citation cluster. There are a large number of different 'Harvard' styles so finding an existing one with the desired output is a pain. Currently the 'Search by Example' tool cannot help with finding a suitable style since the citation only has one example article.

As a stakeholder, I want multiple languages so that the prototype isn't limited to English-speaking users.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:32:27

Roman and non-Roman character support: e.g. Chinese, Arabic, etc.

As a user, I want a WYSIWYG tool that supports multiple languages so that I can format my bibliography in both Chinese and English.

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-06 13:18:31

2 vote on our feedback forum: http://bit.ly/wdJhK4

Milestone III: Creation of Styles

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 15:52:25

This is a placeholder task for a milestone

As a user, I want to be able to preview citation styles so that I can see what styles look like before i choose them.

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-06 04:03:40

12 votes on feedback forum: http://bit.ly/xV9rXK

related request: http://bit.ly/Agd3SO
It would be nice to have a citation style editor where you can change auther name separators, fonts and whatnot.
it would be great if you could see roughly what the different styles look like (in the same way you can see & select fonts) so you could at least pick something close to the style you want.

As a user, I want the editor verify my style against a suite of example citations so that when I make changes, I can be sure that they aren't breaking things.

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:26:27

There's a huge variety if different metadata which a style can act on. The user can't manually parse this every time they make a change.

The user should be able to input a list of example formatted citations (the more the better) which we could run diffs against every time the style changes.

list hosting requirements for functional code

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-01-23 17:01:40

We will need to host the tool online. Hosting options will depend on the functional requirements of the tool. This task is to list those requirements.

setup a project dropbox for documentation of the project

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-01-24 16:56:37

As a user, I want exporting functionality so that I can export citation-style formatted metadata as RTF and HTML.

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-06 13:15:40

5 votes on feedback forum: http://bit.ly/zeKphQ

As a user, I want to see a unique version number of a style so that I can get the most up-to-date version of a style.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:30:07

As a user, I want reliable journal abbreviations so that I don't have to curate abbreviations by hand.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:33:09

As a user, I want a tool for citation mapping so that I can see several generations of referenced and cited by articles..

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-06 03:53:00

19 votes on feedback forum: http://bit.ly/zc75Nf

As a user, I want a GUI or a user-readable XML file so that the mapping between Mendeley and CSL fields is explicit (and editable).

Imported from Sprint.ly

Original Creator: Jessica Mezei
Created at: 2012-02-06 04:09:17

11 votes from our feedback forum: http://bit.ly/zWJBpz

A document on the web fully explaining the mapping scheme would be helpful.

The blog post referred to below only publishes the mapping between CSL item types & Mendeley item types. What is also needed is mapping between CSL variables and fieldnames within Mendeley items (e.g. author, isbn etc) (as noted in the original post).

I am also stuck on mapping for CSL's genre variable. In Zotero this maps to the type field in (at least) the Thesis item type. But in Mendeley it does not seem to do so, even though Mendeley Thesis item does have a type field. This field (I suppose) is used to differentiate between types of thesis (PhD, MSc). I want to access that from my CSL style.

As a user, I want integration with Mendeley so that my styles will show up in my Mendeley account.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:35:48

As a product manager, I want a public home for this project so that all stakeholders and the community can see the progress of the project.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 13:57:23

connect Sprint.ly post commit hooks for CSL project to our github repo.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 14:03:29
Parent issue: #5

set up an initial milestone schedule.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-01-24 17:03:13

As a product manager, I want an investigation into the suitability of existing tools so that I can understand the scope of new work that we need to build.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-03-05 15:10:44

As a user, I want to be notified when a new version of a style is available so that I can keep up-to-date on modified styles.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:31:21

As a user, I want a citation builder so that a wizard can help me through the process of finding/making a style.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:34:14

As a user, I want to specify conditional formatting rules so that my styles work correctly for different document types and metadata.

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:39:07

some GUI mockups by Simon here: http://xbiblio-devel.2463403.n2.nabble.com/Graphical-CSL-Editor-td5927479.html

write up an overview of the successes and failures of the previous CSL editor implementation

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2012-01-24 16:55:04

As a dev lead, I want to set up a github repo for this project so that all stakeholders can see the progress of the project.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 13:39:39

As a user, I want to set sharing preferences so that I can decide whether or not to share the styles I modify/create.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 14:34:47

Far Far Away

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-02-06 15:54:04

This is a placeholder for 'would be nice' tasks or future development

As a user, I want to provide feedback on styles in the repo so that others can fix the style for me.

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:37:40

From Bruce: (http://xbiblio-devel.2463403.n2.nabble.com/CSL-editor-td2618606.html)

If they find a bug in a style, they simply post a note (ideally on a comment form on the web page for the style).

fbennett has a tool for submitting bugs in styles: Feedback Gadget http://citationstylist.org/tools/

As a developer, I want to see related issues from feedback forum so that I can better decide on use cases to solve.

Imported from Sprint.ly

Original Creator: Jeffrey Lancaster
Created at: 2012-01-23 16:54:59

As a project manager, I want to create a public location for the project roadmap so that all stakeholders and the community can see the progress of the project.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 13:40:28

As an author, I want to be able to modify an existing csl style so that I can fine tune my biblography.

Imported from Sprint.ly

Original Creator: Ian Mulvany
Created at: 2011-12-15 13:15:00

Many comments on xbiblio in support of this, e.g.:

From Frederick Gibbs: http://xbiblio-devel.2463403.n2.nabble.com/CSL-editor-td2618606.html
The way I see the tool being most useful is when people can load a fairly complete style, like APA or Chicago, then tweak it, save a new style file, and upload it into a repository.

As a user, I want to use macros to re-use code from other styles so that I minimize the code I need to write (or the amount of GUI editing I need to do).

Imported from Sprint.ly

Original Creator: Steve Ridout
Created at: 2012-01-31 11:46:55

From Bruce: http://xbiblio-devel.2463403.n2.nabble.com/CSL-editor-td2618606.html

Good styles (those that are robust, easy to debug, etc.) depend on good macros.

A piece of evidence that I believe proves my point is that the vast
majority of styles in the Zotero repo are in fact dependent styles.
This means there's actually not as much variation as is commonly
assumed.

So if we have a CSL creation UI that incorporates macros, and
incorporates by default some common ones, it becomes really easy for
users to create new styles.