buda-base / blmp-client

JS client for the BLMP
3 stars 0 forks source link

Editor guide #27

Open berger-n opened 2 years ago

berger-n commented 2 years ago

hi @karmagongde, @JannTibetan

I've updated the Editor guide with many screenshots and how-tos. (any comment, correction or request appreciated, of course)

Among what is not there yet is the part about scan requests that we couldn't figure out exactly without Elie at our last meeting. I'm thinking of a section or two with everything about the Work / Version / Scans workflow.

BTW the document refers to creating & saving a new Topic (because it's one of the simplest kind of entity) but I had to cheat a bit in the screenshots because there's currently a bug that prevents actually saving it... just to say we shouldn't send this document to the librarians before it has been fixed (@eroux it's noted in the project)

karmagongde commented 2 years ago

@berger-n It looks nice and helpful step-by-step instructions with the screenshots. Is the RID Prefix for librarians already default on General Properties or has to add by an individual? For not to contradict with RID prefix on DLMS I suggested the following RID prefix on BUDA Editor: 3KG = Karma Gongde 5CZ = Kelsang Lhamo 5CN = Chungdak Nangpa 9LS = Lobsang Shastri

karmagongde commented 2 years ago

Another big change in the BUDA Editor is the Year format in Events. So, we have to clearly explain in the Editor Guide.

berger-n commented 2 years ago

Thanks @karmagongde!

I've moved the section about the new date format into the Creating a new entity section, and added a few more screenshots.

Regarding the RID prefix, I think each user will have to fill it by himself in his profile.

But before one can try the editor, we need to know the email they use to login to the editor in order to allow them to access the editor (remember first time you tried to use the editor, at first we couldn't figure out why it did not work on your computer :smile: )

berger-n commented 2 years ago

added a section Creating an Instance (with a subsection about Work/Version grouping)

berger-n commented 2 years ago

BTW the document refers to creating & saving a new Topic (because it's one of the simplest kind of entity) ... just to say we shouldn't send this document to the librarians before it has been fixed

thanks @eroux! we can save Topics now

JannTibetan commented 2 years ago

It's fantastic. I will read it carefully this weekend. Thank you