search

gfngfn / SATySFi

A statically-typed, functional typesetting system
GNU Lesser General Public License v3.0
1.16k stars 82 forks source link

Is English documentation available somewhere? #235

Open ComFreek opened 4 years ago

ComFreek commented 4 years ago

So far I could only locate Japenese documentation in this repo's demo files and wiki.

Is English documentation available somewhere?

nekketsuuu commented 4 years ago

Currently, there is no English documentation which fully describes SATySFi's features. AFAIK, it's a TODO task.

gfngfn commented 4 years ago

Thank you for having interest in this project.

Although I have long been willing to write some book for introducing SATySFi in English, we still haven’t got around to it yet as @nekketsuuu -san mentioned.

I have already provided a Japanese version, The SATySFi​book, which has 160 pages and had taken approximately one month of full-time work on writing. It thereby probably takes at least half an year to write English version by myself… It may be worth considering to recruit some paid contributors for translation.

ComFreek commented 4 years ago

For me just having an English extended abstract (1 - 2 pages) describing what this project is about and how exactly it solves things would be enough as a starter.

I am primarily interested in this project from a language design perspective. Currently, I am collecting some design ideas for a TeX successor and certainly "statically typed" is on my list. And this project claims to be statically typed :smile:

claudio-naoto commented 3 years ago

Hi, I'm interested in this project and made a translation of the demo file to english and brazilian portuguese (mainly using google translator). It is not perfect but maybe it is useful. I can send the files if someone find this interesting.

ComFreek commented 3 years ago

@claudio-naoto Yes, please! Thanks for your initiative. Can you publicly share them somewhere, e.g. on GitHub Gists?

claudio-naoto commented 3 years ago

Ok. English demo Brazilian portuguese demo

claudio-naoto commented 3 years ago

Do you know where/how I should change environment labels like "mokuji" to "Table of Contents"?

na4zagin3 commented 3 years ago

@claudio-naoto Thank you so much!

Do you know where/how I should change environment labels like "mokuji" to "Table of Contents"?

It's hard-coded in the class package stdjabook.

https://github.com/gfngfn/SATySFi/blob/360d9417b9ee26fcc89016b9d42c5b27c8b1e304/lib-satysfi/dist/packages/stdjabook.satyh#L393

AFAIK, as of now, there's no class packages with a configurable TOC section header string.

I'm now developing a class file for Latin-script languages, but not yet ready..

https://github.com/na4zagin3/satysfi-fss/blob/master/src/class-nzla/nzla.satyh

na4zagin3 commented 3 years ago

The quickest hack is to copy stdjabook.satyh to the same directory of the document, e.g., ./stdbook.satyh, replace {目次} with {Index}, {Índice}, or anything, and replace the import directive @require stdjabook in the document with @import ./stdbook.