Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should labels have a prefix? #9

Open
jonathanrobie opened this issue Jun 14, 2017 · 6 comments
Open

Should labels have a prefix? #9

jonathanrobie opened this issue Jun 14, 2017 · 6 comments

Comments

@jonathanrobie
Copy link
Member

jonathanrobie commented Jun 14, 2017

Currently, labels do not have a prefix. This is convenient for Greek, but makes parsing more difficult for languages that use Latin characters. We might want to consider requiring a prefix when writing Treedown as text, but letting displays hide the prefix and use syntax highlighting to improve figure/ground.

If we add a prefix, then markup like this:

s χάρις
io ὑμῖν
s καὶ εἰρήνη
v πληθυνθείη.

would have a prefix added to each alphabetic label, e.g. if the prefix is ':':

:s χάρις
:io ὑμῖν
:s καὶ εἰρήνη
:v πληθυνθείη.

@jtauber
Copy link
Collaborator

jtauber commented Jun 15, 2017

When you say "parsing" do you mean by humans or by machine?

I don't think it makes a difference to humans (as you say, displays will hide it anyway, and syntax highlighting will make the distinction clear in editors).

Is your concern machine parsing in the cases where I line does NOT have any label but starts with a word that looks like a label?

@jonathanrobie
Copy link
Member Author

jonathanrobie commented Jun 15, 2017

I mean by machine, and especially across languages like English that use the Latin alphabet. And especially in the case of a line that does not have a label.

I noticed this creating Treedown for English sentences to illustrate concepts.

@jtauber
Copy link
Collaborator

jtauber commented Jun 15, 2017

Yeah, I can see why this would be helpful where a line doesn't have a label. Makes the regex for syntax highlighting in an editor more robust too.

@jonathanrobie
Copy link
Member Author

I think we should either (1) require the label, or (2) prefix labels, but not both. I'm inclined to go with the prefix. To me, figure/ground issues and readability are the most important criteria for this choice.

@jtauber
Copy link
Collaborator

jtauber commented Jun 15, 2017

Does the lack of a label imply a particular label (or subset of labels) or is it possible for "incremental" treedown to involve doing the indentation without yet choosing labels. The latter would seem quite useful. In other words, support breaking the clause down into verb and arguments without yet labelling the argument roles.

@rkjtan
Copy link

rkjtan commented Jun 16, 2017

I agree with James that "incremental" treedown that does indentation without yet choosing labels would be useful. So, could we add: (1) Make it optional for users to add the prefix or not (probably most users would omit it for convenience's sake); but (2) automatically convert any files to add the prefix everywhere it ought to be (even if there is no label, but the indentation/spacing indicates that a label could/should be added at some point? That way, for example, people who prefer to label conj or not would still have files that are compatible (those who have conj have extra conj labels while those who don't just have the prefix with no label, but the indentation & spacing would be the same for both camps).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants