search

Signbank / Global-signbank

An online sign dictionary and sign database management system for research purposes. Developed originally by Steve Cassidy/ This repo is a fork for the Dutch version, previously called 'NGT-Signbank'.
http://signbank.cls.ru.nl
BSD 3-Clause "New" or "Revised" License
19 stars 12 forks source link

API Wiki is a bit confusing due to markup #1252

Closed susanodd closed 2 days ago

susanodd commented 3 months ago

I noticed that the Create Gloss API endpoint isn't shown in the wiki, but examples of it are shown in the examples section.

I can't recall whether the Create Gloss used to be included or not. When editing in the markup, you edit the entire text and need to scroll endlessly to find things, all written in the markup syntax. I worry things are going to be deleted by accident this way.

susanodd commented 3 months ago

I added a section for Create Gloss. And I filled in the "to do" areas.

susanodd commented 3 months ago

What to do about API input field syntax? Should this be yet another API page? For updating the morphology, I made an additional endpoint, since these are relations, not merely fields.

/dictionary/api_update_gloss_morphology/[datasetid]/[glossid]/

The following can be updated now (on signbank-dev):

  1. Sequential Morphology (gloss annotations separated by plus surrounded by spaces: +

GLOSS1 + GLOSS2 + GLOSS3

  1. Simultaneous Morphology (morpheme annotations separated by comma followed by space: ,

MORPHEME1:meaning1, MORPHEME2:meaning2

  1. Blend Morphology (gloss annotations separated by comma followed by space: ,

GLOSS1:role2, GLOSS2:role2

Woseseltops commented 3 months ago

I added a section for Create Gloss. And I filled in the "to do" areas.

Great, looks good to me. Does that mean this issue is finished already?

What to do about API input field syntax? Should this be yet another API page?

I'm not sure how this would be different from what is already here... let's discuss when we see each other face to face

susanodd commented 3 months ago

I added a section for Create Gloss. And I filled in the "to do" areas.

Great, looks good to me. Does that mean this issue is finished already?

What to do about API input field syntax? Should this be yet another API page?

I'm not sure how this would be different from what is already here... let's discuss when we see each other face to face

I'm not sure. Maybe it needs more pages so they show up in the right-hand bar? I also think the syntax of the parameters is confusing.

susanodd commented 2 days ago

This issue is subsumed by #1317