zotero / scaffold

Zotero translator creation IDE
http://www.zotero.org/support/dev/scaffold
38 stars 9 forks source link

New functionality: Add a template #46

Closed zuphilip closed 6 years ago

zuphilip commented 6 years ago

This should include the ideas discussed in #39 and an attempt for #44.

Here is a screenshot: scaffold-add-template

This is a first attempt and we can discuss some of the things.

adomasven commented 6 years ago

General comments, coming from not having worked on translators before, so may just be uninformed:

  1. We should consider having a menubar in Scaffold, even if with a single menupopup Templates.

  2. Does it make sense for List all types and add item templates to insert into code editor? This is especially confusing if you have import pane open instead of code. How about displaying the templates in the right pane?

zuphilip commented 6 years ago

To 1: I just to tried to adapt the layout to what is already there, but I am fine with menus or buttons either ways. (Also I have the impression that more software is changing from menus to buttons, e.g. Firefox, Office.)

To 2: That is a good question. The main idea for this was formulated in #44 by @dstillman. I agree that the item types and the item templates are more like some sort of live documentation inside the editor, than code we can reuse immediately. Thus, I could imagine that displaying them in the right pane could work quite nicely.

Maybe Dan or Sebastian have some more ideas and we can then try to reach some consensus.

zuphilip commented 6 years ago

Please have a look at the new version which uses now separate files and addresses the point 2.

adomasven commented 6 years ago

I just to tried to adapt the layout to what is already there, but I am fine with menus or buttons either ways. (Also I have the impression that more software is changing from menus to buttons, e.g. Firefox, Office.)

I personally don't like the change to all buttons and the argument for menus is that they provide somewhat natural shortcuts and are labelled -- icons are more confusing than a label.

zuphilip commented 6 years ago

Please have a look at the new version. I tried to make all changes discussed above, except moving the "Add a template" button into a menu. I will try to do this change the next days...

zuphilip commented 6 years ago

I switched to a menu instead of a button containing these four functions. Here is a how this looks in action:

2017-10-14_18-11-02

@adomasven What do you think?

zuphilip commented 6 years ago

Please have a look at the new version, which look like this:

scaffold-new

zuphilip commented 6 years ago

(

...unless they apply to Import too, but I'm not actually not sure what that tab does...

@dstillman For testing import translators one can input data there, e.g. some RIS data and then test the import functions. )

adomasven commented 6 years ago

I think this looks kinda bad due, perhaps due to the alignment of the button, or just in general the amount of stacking there (although with #54 there will be less stacking, so maybe then it's fine).

I'm also inclined to just merge this anyway and address this with further PRs. This is not a user-facing piece of software and there's little incentive to try to get it perfect. We can adjust the UI as needed, but months-long reviews are kinda discouraging to do that.