liblouis
liblouis copied to clipboard
liblouis
Added 'Chinese Mandarin Chinese Common Braille Scheme'
introduction
Chinese Common Braille Scheme is a type of Braille used for spelling Mandarin Chinese, The basis is the "Chinese Current Braille System"(i.e. zhcn-g1.ctb), In 2018, the Chinese Common Braille Scheme was jointly issued and implemented by the Ministry of Education of the People's Republic of China, the National Language and Character Work Committee and the China Disabled Persons' Federation in the form of "Language and Character Specifications".
The Chinese Common Braille Scheme is not much different from the "Chinese Current Braille System", but the former has more perfect marking rules and produces less ambiguity than the latter without marking.
test
I ran a yaml test and SUCCESS (20 tests, 0 failures).
Hm, something doesn't seem quite right with the meta data. @bertfrees any idea?
Do I need to provide a YAML test file?
Definitely. And you said above that you ran a yaml test already. Why not provide that one?
Hi @cary-rowen I think I took care of the build failures:
- I added the YAML file
- I adapted the Makefiles to include the new table and the YAML tests
- I adapted the meta data and the display names so that the table is properly indexed and found by the tests
In the comment section of your new table you add a link to a brief introduction. Could you also add a link to the standard itself?
Hello, @egli
Well done! Thanks for your work.
I have added the download link of the national standard file according to your request.
Btw, I'm new to this project and I didn't see full steps for adding a table in the wiki "How to contribute", It may need to be updated.
Best Cary
Can you elaborate a bit more on the difference with the "Chinese Current Braille System"?
Perhaps you can add some examples to the YAML file that help explain the difference? The YAML file is currently very minimal, some more test data would definitely not hurt.
@cary-rowen Another question: what exactly is the Chinese National Standard GB/T 15720-2008 that you linked to in https://github.com/liblouis/liblouis/issues/1234 and does it also mention the Chinese Common Braille Scheme?
Hi, @egli
Can you elaborate a bit more on the difference with the "Chinese Current Braille System"? What does "more perfect marking rules" mean?
The more perfect marking rules mean the rules of adding tones. Compared with "Chinese Current Braille System", the biggest difference of "Chinese Common Braille Scheme" is that more Chinese characters need to be added tones, Tone is added to almost (but not all) every Chinese character.
I'm unsure whether this should be seen as a new system, or rather a variant of the "Chinese Current Braille System"?
It is not a new system, rather it is an upgraded version of "Chinese Current Braille System", From July 1, 2018, all Braille publications printed in China use the "Chinese Common Braille Scheme" instead of the "Chinese Current Braille System".
• Can the table be used for simplified Chinese character or traditional or both?
Currently this table is only available for Simplified Chinese,
For uniformity with other display names I suggest changing "Chinese Common Braille Scheme" to "Chinese common braille". The "scheme" is redundant, and everything that is not a proper name is lowercase.
"Chinese Current Braille System" and "Chinese double-phonic braille System" are proprietary in GB/T 15720-2008 noun.
"Chinese Common Braille Scheme" is also a proper noun, but it is not included in GB/T 15720-2008, but in pdf files in zhcn-cbs.ctb.
@bertfrees
Perhaps you can add some examples to the YAML file that help explain the difference? The YAML file is currently very minimal, some more test data would definitely not hurt.
Maybe I can try to extract some samples from zhcn-g1.yaml and add them to zhcn-cbs.yaml to compare and illustrate the difference, what do you think?
Maybe I can try to extract some samples from zhcn-g1.yaml and add them to zhcn-cbs.yaml to compare and illustrate the difference, what do you think?
Good.
@bertfrees It seems that there are not many test samples provided by zhcn-g1.yaml, which is not enough to reflect the biggest difference between the two tables. I listed another 10 samples and added them to the yaml test of this PR. Is this okay?
Btw, I'm new to this project and I didn't see full steps for adding a table in the wiki "How to contribute", It may need to be updated.
I agree that this is not documented, but I'm a bit hesitant. Most of our table contributors aren't programmers and the process is already complicated enough as it is. I don't really want to burden them with the arcane details of our build system (in which Makefile.am does the table go and in which Makefile.am files do I need to add the YAML test).
But then again, the page you mention is a wiki page that can be edited by anyone. If you find a place to put this information then by all means, go ahead :-)
@egli Can you approve the testing process? What else needs to be done before merging?
It seems that there are not many test samples provided by zhcn-g1.yaml, which is not enough to reflect the biggest difference between the two tables. I listed another 10 samples and added them to the yaml test of this PR. Is this okay?
OK great. But what I suggest to do now is:
- add the following section at the bottom to illustrate the differences with zhcn-g1:
# to illustrate the differences with the current braille system the current braille system # table is applied to the same inputs: table: {system: cmn-traditional} tests: - [苹果, ⠏⠡⠂⠛⠕⠄] - [电脑, ⠙⠩⠆⠝⠖⠄] - [橘子, ⠛⠬⠂⠵⠄] - [老马识途, ⠇⠖⠄⠍⠔⠄⠱⠂⠞⠥⠂] - [相敬如宾, ⠓⠭⠁⠛⠡⠆⠚⠥⠂⠃⠣⠁] - [飞黄腾达, ⠋⠮⠁⠓⠶⠂⠞⠼⠂⠙⠔⠂] - [如鱼得水, ⠚⠥⠂⠬⠂⠙⠢⠂⠱⠺⠄] - [今天的天气不错, ⠛⠣⠁⠞⠩⠁⠙ ⠞⠩⠁⠅⠊⠆⠃⠥⠆⠉⠕⠆] - [做人要有梦想, ⠵⠕⠆⠚⠴⠂⠜⠆⠳⠄⠍⠼⠆⠓⠭⠄] - [朝月亮出发, ⠟⠖⠂⠾⠆⠇⠭⠆⠟⠥⠁⠋⠔⠁] - [最深最重的爱，须与时日共成长。, ⠵⠺⠆⠱⠴⠁⠵⠺⠆⠌⠲⠆⠙ ⠪⠆⠐ ⠓⠬⠁⠬⠄⠱⠂⠚⠆⠛⠲⠆⠟⠼⠂⠌⠦⠄⠐⠆] - [这是我的国土, ⠌⠢⠆⠱ ⠕⠄⠙ ⠛⠕⠂⠞⠥⠄] - [战略合作协议, ⠌⠧⠆⠇⠾⠆⠓⠢⠂⠵⠕⠆⠓⠑⠂⠊⠆] - [中国是发展中国家, ⠌⠲⠁⠛⠕⠂⠱ ⠋⠔⠁⠌⠧⠄⠌⠲⠁⠛⠕⠂⠛⠫⠁] - [尊老爱幼是中华民族的传统美德, ⠵⠒⠁⠇⠖⠄⠪⠆⠳⠆⠱ ⠌⠲⠁⠓⠿⠂⠍⠣⠂⠵⠥⠂⠙ ⠟⠻⠂⠞⠲⠄⠍⠮⠄⠙⠢⠂] - [你好, ⠝⠊⠄⠓⠖⠄] - [他们, ⠞⠔⠍⠴] - [它们, ⠈⠞⠔⠁⠍⠴] - [她们, ⠞⠔⠁⠍⠴] - [海浪, ⠓⠪⠄⠇⠦⠆] - [句子, ⠛⠬⠆⠵⠄] - [巨资, ⠛⠬⠆⠵⠁] - [好朋友, ⠓⠖⠄⠏⠼⠂⠳⠄] - [好客, ⠓⠖⠆⠅⠢⠆] - [备课, ⠃⠮⠆⠅⠢⠆] - add comments to your test data to explain the differences with the current braille system
What else needs to be done before merging?
We still need some elaboration on what "more perfect marking rules" means exactly. Hopefully you can achieve this through comments in the YAML file.
@bertfrees
add comments to your test data to explain the differences with the current braille system.
Exactly, I don't know how to explain their differences. The clearest way to compare the differences is to write these entries in the Current Braille System in the form of comments, but does this really make sense?
@bertfrees I see you have done some work for me, thanks. Since I am not a native English speaker, what else do I need to do now?
The only thing left to do is what I asked you yesterday: see https://github.com/liblouis/liblouis/pull/1233#pullrequestreview-1087856119.
Don't worry if you think your English is not good enough. If your text is hard to understand we'll correct it.
Oh and please don't press any "Unresolve conversation" buttons yourself, that's confusing for us :)
I still don't quite get how it works. Probably that is because of my lack of knowledge of Chinese braille in general. Maybe you could elaborate a bit on "more perfect marking rules" for the layman like me. What exactly is marked? I understand that tones are a kind of marking that can be omitted when it causes no ambiguity. But what are other markings?
Hello @bertfrees , Since Chinese is a pinyin type of script, in other words, maybe each Chinese character needs two Braille cells.
In addition to the tonal rules that can be abbreviated, the Chinese Common Braille Scheme provides six shorthand words, that is, we can use one Braille cell to express the meaning of two cells, which I have reflected in my YAML test. The six abbreviations are as follows:
- '的' ⠙⠢ is abbreviated ⠙
- '麼' ⠍⠢ is abbreviated ⠍
- '你' ⠝⠊⠄ is abbreviated ⠝
- '他' ⠞⠔ is abbreviated ⠞
- '她' ⠞⠔⠁ is abbreviated ⠞⠁
- '它' ⠁⠞⠔ is abbreviated ⠁⠞
Here is a core data analysis for those who understand Chinese to consult: http://www.zgmx.org.cn/newsdetail/d-71200-0.html
OK, Hope your question has been resolved, let me know if there is anything I need to do.
@cary-rowen Thanks for all the information! But I would be grateful if you would incorporate it in the source code (the table and test files). I'm not just asking questions for my own better understanding. This is about documentation. This is for everyone who comes along your table and wonders how it differs from other Chinese tables.
Thanks. I've now cleaned up the branch, rebased it on master, and force-pushed it.
While looking over everything I stumbled upon something that could be a show stopper: The zhcn-g1.ctb table, which we identified as the table for the "Chinese current braille scheme", apparently also carries the name "Chinese Common Braille" and even references the same PDF (W020180725666187054299.pdf). Yet it does differ from the new table in the ways Cary-rowen explained.
This is confusing. @cary-rowen How should we solve this situation?
On line 66 of zhcn-g1.ctb, That is, "GB/T 15720-2008" stipulates that the name of the braille scheme of zhcn-g1.ctb is "Chinese current braille system". And the file W020180725666187054299.pdf pointed to by line 66 of zhcn-g1.ctb is not the PDF version of GB/T 15720-2008. The file is currently unavailable for download, the link is invalid.
So, I suggest to reference this file in zhcn-cbs.ctb: http://www.zgmx.org.cn/back/kindeditor-4.0.4/attached/file/20180822/20180822094740_7094.rar
This file is a Braille printable version of the Chinese Common Braille Study Manual.
The Chinese Common Braille Scheme teaching manual in Braille is as follows: https://class.kh.edu.tw/sites/19061/bulletin_file/210/%E5%9C%8B%E5%AE%B6%E9%80%9A%E7%94%A8%E7%9B%B2%E6%96%87%E8%87%AA%E5%AD%B8%E8%BC%94%E5%B0%8E%E8%AC%9B%E7%BE%A9-%E6%AD%A3%E6%96%87-%E5%8D%B0%E5%88%B7%E7%94%A8.pdf
On line 66 of zhcn-g1.ctb, That is, "GB/T 15720-2008" stipulates that the name of the braille scheme of zhcn-g1.ctb is "Chinese current braille system".
OK. Could you correct it perhaps? And it would be great if we could also double-check with the author of that table @loomee.
And the file W020180725666187054299.pdf pointed to by line 66 of zhcn-g1.ctb is not the PDF version of GB/T 15720-2008. The file is currently unavailable for download, the link is invalid.
Well, presumably it did link to the same file at one point. Could the link be corrected?
所以，我建议在 zhcn-cbs.ctb 中引用 http://www.zgmx.org.cn/back/kindeditor-4.0.4/attached/file/20180822/20180822094740_7094.rar This file is a Braille printable version of the Chinese Common Braille Study Manual.
OK. Sounds relevant. Why do you mention it but don't add it as a comment to the table?
The Chinese Common Braille Scheme teaching manual in Braille is as follows: https://class.kh.edu.tw/sites/19061/bulletin_file/210/%E5%9C%8B%E5%AE%B6%E9%80%9A%E7%94%A8%E7%9B%B2%E6%96%87%E8%87%AA%E5%AD%B8%E8%BC%94%E5%B0%8E%E8%AC%9B%E7%BE%A9-%E6%AD%A3%E6%96%87-%E5%8D%B0%E5%88%B7%E7%94%A8.pdf
This link does not seem to work.
By the way, broken links are the reason why sometimes we opt for copying all relevant documentation about braille codes to our own website: http://liblouis.org/braille-specs/. I think it would be a good idea to do that for Mandarin as well.