Hi,

On 17 November 2012 22:29, Rintze Zelle <[email protected]> wrote:
> On Sat, Nov 17, 2012 at 12:29 PM, Bruce D'Arcus <[email protected]> wrote:
>> On Sat, Nov 17, 2012 at 12:16 PM, Carles Pina <[email protected]> 
>> wrote:
>>
>>> I'd like to add, in our documentation, some information for our users
>>> with the steps to submit changes to the repository. I don't expect all
>>> the changes to be pushed back to the repository since it needs some
>>> extra work and back and forth. Indeed we should help the users who
>>> wants to do it.
>>
>> I haven't looked at your integration, but is it feasible at some point
>> to allow users to submit styles to github with something close to one
>> click from within the editor?
>
> How would reviewing of style submissions work in that case? It seems
> rather important to be able to have a dialog with the submitter. I'm
> also not looking forward to dealing with a much larger volume of
> submissions that I do now.

let me to explain...

PART 1: What happened
The mentioned bug with the invalid "self link" happened because when I
did the integration I disabled the call to
conformStyleToRepoConventions:
https://github.com/citation-style-editor/csl-editor/blob/master/src/VisualEditor.js#L417

I disabled it because I didn't want part of the checks that it's
doing, particularly the "generatedStyleId" which enforces the user to
match the styleName and the styleId. I think that a valid use case is
a user who changes the styleTitle but who doesn't want to change now
the styleId in his style (not the repository one!). If we would
enforce changing the styleId when the styleName is changed it would
break existing references to the style (could be solved with dependent
styles but it seems complicated).

But disabling the conformStyleToRepoConventions I introduced the bug
that has been mentioned before about the ' "no "self" link'. This is
the explanation that the Mendeley editor generated a style without the
"no self link" and the Steve Ridout demo does it correctly.

PART 2: CSL Editor integration with github
I don't think that we should force Mendeley users to send the styles
to the project. Why? Because some style edits are tests, local
variations... and because if some user sends the style to the
repository needs to be ready to take care of the style, communicate
why something is done, why is done, etc.
(we should help the user who wants to do it, indeed).

I use lot of free software, I modify different programs, but I only
send to the upstream projects part of what I change. Some changes are
things that only affects me, or that to implement properly would take
too long (I need a special function that works to me but maybe not in
all platforms and circumstances). Some things that I change would need
testing, and I only test in my computer, a proper UI, etc.

Lots of Mendeley users don't know about free software, or don't know
about git, collaborative projects, they don't have time or energy to
communicate with the CSL project, etc.

Now, in the Mendeley CSL Editor we have a Style menu with some
options: "New Style" (we discussed if this option should/could be
removed, let's not discuss it here now), "Load Style", "Save Style",
"Save Style As...", "Logout".

I think that would make sense to have "Export style to CSL project",
with a dialog explaining what would happen, implications and what to
expect, ask for their email address and then the Mendeley CSL Editor
could create a gist (I see that it has an API:
http://developer.github.com/v3/gists/#create-a-gist ). And it could
send the gists to some place.

Or perhaps the CSL Editor should fork and push a patch, I would need
to investigate the github APIs, etc.

Actually, this could be implemented in the csl-editor and not the
Mendeley one since it could be useful for other implementors.

I think that only a very few users would press the button to export to
the project.

-- 
Carles Pina | Software Engineer
http://www.mendeley.com/profiles/Carles-Pina/

Mendeley Limited | London, UK | www.mendeley.com
Registered in England and Wales | Company Number 6419015

------------------------------------------------------------------------------
Monitor your physical, virtual and cloud infrastructure from a single
web console. Get in-depth insight into apps, servers, databases, vmware,
SAP, cloud infrastructure, etc. Download 30-day Free Trial.
Pricing starts from $795 for 25 servers or applications!
http://p.sf.net/sfu/zoho_dev2dev_nov
_______________________________________________
xbiblio-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xbiblio-devel

Reply via email to