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

Spelling: Manuscript, could not, process, … No content #588

Merged
merged 2 commits into from Jun 6, 2019

Conversation

comradekingu
Copy link
Contributor

No description provided.

@worstje
Copy link
Contributor

worstje commented Jun 1, 2019

Most of that looks okay. The only thing I wonder about is the 'Manuskript' one.

I think the capitalized 'Manuskript' is only used for the application name on Mac in order to fit in on the greater mac ecosystem, but that lowercase is otherwise the default.

What's the policy on this, @gedakc ?

@comradekingu
Copy link
Contributor Author

@worstje
Copy link
Contributor

worstje commented Jun 1, 2019

I am not saying we shouldn't have consistency. I don't even care which of the consistency options we go with (uppercase Manuskript like in this PR has my preference!); I just want to know exactly what the rule with regards to branding is here.

This old pull request had a brief discussion on what was suitable for the app / binary / package name and how that would make the Mac app differ from the rest of the builds. It is what was on my mind when I saw your PR, so rather than just blindly agreeing with your suggestion, I want to understand exactly what rules we follow in regards to capitalization.

Maybe those rules are already written out somewhere, but maybe they are as-of-yet unwritten... in which case it wouldn't hurt to have them questioned and consequently spelled out, right? 😄

@comradekingu
Copy link
Contributor Author

comradekingu commented Jun 1, 2019

@worstje Indeed.
It isn't at all clear that some strings belong to the macOS client when translating.
The law of the land then becomes doing what consistent application there is in the first few strings.

It isn't a library, and doing "Manuskript" takes the guesswork out of what to do when a sentence starts with "m/Manuscript".

https://www.theologeek.ch/manuskript/ only has two "manuskript", and one "MANUSCRIPT", otherwise "Manuskript". Website could do with some fixes elsewhere.
All "Manuskript" on https://alternativeto.net/software/manuskript/.

@gedakc
Copy link
Collaborator

gedakc commented Jun 2, 2019

What's the policy on this (Manuskript upper/lowercase "m" usage)?

As far as I know there is no documented or agreed upon policy. As best I can tell the project name "Manuskript" is a simple play on / misspelling of the English word "manuscript".

In my opinion because "manuskript" is not a English word in a dictionary, I think references to the "Manuskript" project and application should use uppercase "M". When referring to invoking the executable from the command line I think lowercase "m" should be used as in manuskript.

On the topic of this PR, I wonder why the change from "Plain text" to "Plaintext"?

The two English words "plain text" are descriptive and match the definition of plain text when referring to computer terms. See Plain Text.

From my brief research it would seem that the combined word "plaintext" refers to cryptography which is not the intended meaning. See Plaintext.

@comradekingu
Copy link
Contributor Author

comradekingu commented Jun 3, 2019

@gedakc that is a distinction that has faded. The reason for doing it is to avoid compound word errors in translation. It avoids having to consider the rules of stricter languages. It could be "cleartext" for similar benefit.
In my head "plain text" doesn't have any markup, whereas "plaintext" could, but not using emoticons and complex chars.

@gedakc
Copy link
Collaborator

gedakc commented Jun 4, 2019

@worstje what are your thoughts regarding "plain text" versus "plaintext"?

@worstje
Copy link
Contributor

worstje commented Jun 6, 2019

Definitely plain text. While Wikipedia is not exactly the best source in existence, I think it is sufficient for this argument, and it has two articles, one both spellings.

Plain text - No images, no markup. Can be unicode, but unicode includes emojis, so IMHO emojis are totally fine for this.

Plaintext - "In cryptography, plaintext usually means unencrypted information pending input into cryptographic algorithms, usually encryption algorithms. Cleartext usually refers to data that is transmitted or stored unencrypted ('in the clear')."

(Edit: Just spotted that @gedakc already linked these as well, whoops. We're thinking along the same lines, I suppose!)

Ergo, plaintext is very much not what we want. While the interpretation of plain text might leave to be desired in regards to specific details (markup? images?) I think in the context of saving, it would make most sense to accept the most basic version of plain text: no formatting whatsoever. Of course, if you open a file as plain text, that means you are still exposed to all the formatting codes that would have absolutely no meaning.

If we want to truly specify formatting in a 'saving' context, then we have a more suitable name for it, and that is the name of the formatting language used. Manuskript uses .md for Markdown, so what prevents us from referring to that? The same goes for things like (la)tex, html, rtf and whatnot.

@comradekingu
Copy link
Contributor Author

@worstje The latter part of your argument is why I prefer "plaintext", markdown is still in the clear, whereas it isn't just plain text. It does use plain text chars though, so just there it could not qualify as plain text, as it relates to rules of how to write text.

For OTOH, "in the clear", It becomes a question of what is even humanly readable.
For an easy way to see it, "plaintext" is the least obfuscated version.

But is it even a thing to use it like that, or does "plaintext" have to be cryptographic, or is there even a problem using cryptographic terms to describe something?

@gedakc
Copy link
Collaborator

gedakc commented Jun 6, 2019

We do have differing opinions. Because the original author chose "plain text" over "plaintext" and because the majority lean towards the two word "plain text" lets keep it that way.

@comradekingu if you change this PR back to the original two word "plain text" then I can merge it with the develop branch.

@comradekingu comradekingu changed the title Spelling: Plaintext, Manuscript, could not, process, … No content Spelling: Manuscript, could not, process, … No content Jun 6, 2019
@comradekingu
Copy link
Contributor Author

@gedack OK :)

@gedakc
Copy link
Collaborator

gedakc commented Jun 6, 2019

Thanks for the updated patch set. I will squash and merge.

@gedakc gedakc merged commit 761be57 into olivierkes:develop Jun 6, 2019
@gedakc gedakc added this to the 0.10.0 milestone Jun 6, 2019
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

Successfully merging this pull request may close these issues.

None yet

3 participants