The new wiki is on github

116 views
Skip to first unread message

Brandon Barker

unread,
Aug 8, 2014, 5:43:32 PM8/8/14
to ats-lan...@googlegroups.com
In an effort to consolidate some resources around github, the new wiki can be found at:


It now has over 35 articles on ATS (that aren't complete stubs). To be fair, most of them could still use a lot of work.

A new feature that has been put on the wiki to help facilitate review/additions is the TODO;


Happy friday and happy editing.

gmhwxi

unread,
Aug 8, 2014, 6:00:11 PM8/8/14
to ats-lan...@googlegroups.com
That's a great effort. Thanks a lot!

Brandon Barker

unread,
Aug 8, 2014, 6:36:27 PM8/8/14
to ats-lang-users
No problem - it is a great type of activity to do while not having
quite enough sleep :).

I actually think there is probably a fair bit of content on this forum
I've missed in adding, since there have been periods recently where I
haven't been as diligent as I would like.

Another possibility is to copy examples from the ATS book (if you
don't mind, though of course a reference is good), in order to have a
different way of finding relevant topics.

Brandon Barker
brandon...@gmail.com
> --
> You received this message because you are subscribed to the Google Groups
> "ats-lang-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to ats-lang-user...@googlegroups.com.
> To post to this group, send email to ats-lan...@googlegroups.com.
> Visit this group at http://groups.google.com/group/ats-lang-users.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/ats-lang-users/a41cd796-92c4-401f-9bcf-e66a25e26c8b%40googlegroups.com.

Yannick Duchêne

unread,
Aug 8, 2014, 7:52:26 PM8/8/14
to ats-lan...@googlegroups.com


Le samedi 9 août 2014 00:36:27 UTC+2, Brandon Barker a écrit :
No problem - it is a great type of activity to do while not having
quite enough sleep :).
 
Depends on why one does not have enough sleep :p (just teasing, nothing bad)

Another possibility is to copy examples from the ATS book (if you
don't mind, though of course a reference is good), in order to have a
different way of finding relevant topics.

So with a link to the original, otherwise people will get lost (wondering what's the authoritative reference).
 

Yannick Duchêne

unread,
Aug 8, 2014, 7:54:28 PM8/8/14
to ats-lan...@googlegroups.com


Le vendredi 8 août 2014 23:43:32 UTC+2, Brandon Barker a écrit :
In an effort to consolidate some resources around github, the new wiki can be found at:


Just wanted to say I don't forget your mail. If I'm long, this is just that I'm still investigating ATS2… does not mean I forget the wiki. 

gmhwxi

unread,
Aug 8, 2014, 10:16:37 PM8/8/14
to ats-lan...@googlegroups.com
Sure. Please feel free to copy examples from the ATS book.

Yannick Duchêne

unread,
Aug 9, 2014, 8:21:22 PM8/9/14
to ats-lan...@googlegroups.com
Le vendredi 8 août 2014 23:43:32 UTC+2, Brandon Barker a écrit :
In an effort to consolidate some resources around github, the new wiki can be found at:

 
Broken link detected on https://github.com/githwxi/ATS-Postiats/wiki/Frequently-asked-questions. The sentence “For ATS, there is an unofficial (and incomplete) reference available” ends with a link which leads to a 404 error page.


Happy friday and happy editing.

Is the wiki to be edited on‑site or using SVN? (I'm asking about it, because there is a link to locally clone the wiki).

Brandon Barker

unread,
Aug 9, 2014, 9:28:26 PM8/9/14
to ats-lang-users, Chris Double
I believe that missing pdf is from Chris Double, so I'm replying to
him for advice. I'm guessing that removing it may be the best thing,
since I think it is for ATS1.

I believe editing on site is probably easier in most cases than I can
think of. The git repo may be good for doing full text searches of the
wiki, which are sadly not an option using github's web interface at
the moment (but I sent them an e-mail to request the feature).

Thanks!

Brandon Barker
brandon...@gmail.com
> --
> You received this message because you are subscribed to the Google Groups
> "ats-lang-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to ats-lang-user...@googlegroups.com.
> To post to this group, send email to ats-lan...@googlegroups.com.
> Visit this group at http://groups.google.com/group/ats-lang-users.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/ats-lang-users/f1909948-c8af-4ca3-b033-8e1486f41347%40googlegroups.com.

Chris Double

unread,
Aug 10, 2014, 6:28:06 AM8/10/14
to ats-lan...@googlegroups.com
On Sun, Aug 10, 2014 at 1:28 PM, Brandon Barker
<brandon...@gmail.com> wrote:
> I believe that missing pdf is from Chris Double, so I'm replying to
> him for advice.

Thanks for pointing it out - it got lost in a disk crash. I've
recovered it and put it back online.

--
http://www.bluishcoder.co.nz

Kiwamu Okabe

unread,
Aug 14, 2014, 8:54:02 AM8/14/14
to ats-lang-users
Hi Brandon,

On Sat, Aug 9, 2014 at 6:43 AM, Brandon Barker <brandon...@gmail.com> wrote:
> In an effort to consolidate some resources around github, the new wiki can
> be found at:
>
> https://github.com/githwxi/ATS-Postiats/wiki

We start to translate it into Japanese, today.
(Using http://po4a.alioth.debian.org/.)

https://github.com/jats-ug/ATS-Postiats-wiki/

The wiki includes the information what I did want to know half a year ago.
I believe beginners can learn ATS language more easily and speedily on
side of your work.

Thank's for your great work!
--
Kiwamu Okabe at METASEPI DESIGN

Brandon Barker

unread,
Aug 14, 2014, 1:07:18 PM8/14/14
to ats-lang-users
Hi Kiwamu,

This is very cool; I was a bit worried about how the wikis might stay synchronized:

"The po4a (PO for anything) project goal is to ease translations (and more interestingly, the maintenance of translations)."

Github's notification system and lack of diff view for wiki changes is currently not so great; hopefully that will change. This probably puts you in a better position than most to track changes (i.e. catch my mistakes :)).

I added a clone for this  just now (https://github.com/bbarker/ATS-Postiats-wiki), but the downside is that it requires me to manually update fetch, merge, and push, though I can probably find a way to automate it.



Brandon Barker
brandon...@gmail.com
> --
> You received this message because you are subscribed to the Google Groups "ats-lang-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to ats-lang-user...@googlegroups.com.
> To post to this group, send email to ats-lan...@googlegroups.com.
> Visit this group at http://groups.google.com/group/ats-lang-users.

Kiwamu Okabe

unread,
Aug 14, 2014, 1:40:31 PM8/14/14
to ats-lang-users
Hi Brandon,

On Fri, Aug 15, 2014 at 2:06 AM, Brandon Barker
<brandon...@gmail.com> wrote:
> This is very cool; I was a bit worried about how the wikis might stay
> synchronized:
>
> "The po4a (PO for anything) project goal is to ease translations (and more
> interestingly, the maintenance of translations)."
>
> Github's notification system and lack of diff view for wiki changes is
> currently not so great; hopefully that will change. This probably puts you
> in a better position than most to track changes (i.e. catch my mistakes :)).
>
> I added a clone for this just now
> (https://github.com/bbarker/ATS-Postiats-wiki), but the downside is that it
> requires me to manually update fetch, merge, and push, though I can probably
> find a way to automate it.

Umm... I think it has no problem. Because my work flow is:

## 1. Git pull upstream master

$ pwd
/home/kiwamu/doc/ATS-Postiats-wiki.jats-ug
$ git branch -a
* master
translate_ja
remotes/origin/HEAD -> origin/master
remotes/origin/master
remotes/origin/translate_ja
remotes/upstream/master
$ grep -C 1 url .git/config
[remote "origin"]
url = g...@github.com:jats-ug/ATS-Postiats-wiki.git
fetch = +refs/heads/*:refs/remotes/origin/*
--
[remote "upstream"]
url = https://github.com/githwxi/ATS-Postiats.wiki.git
fetch = +refs/heads/*:refs/remotes/upstream/*
$ git pull upstream master
remote: Counting objects: 3, done.
remote: Compressing objects: 100% (3/3), done.
remote: Total 3 (delta 2), reused 0 (delta 0)
Unpacking objects: 100% (3/3), done.
From https://github.com/githwxi/ATS-Postiats.wiki
* branch master -> FETCH_HEAD
8fb40af..f410a52 master -> upstream/master
Updating c578a11..f410a52
Fast-forward
ATS-LF.md => ATSLF.md |
10 +++++-----
Building-and-installing.md | 4 ++--
contrib.md => Contrib.md | 6 ++----
ATS-Libraries-and-C-Library-bindings.md => Contributed-Libraries.md | 0
TODO.md | 2 ++
atsdoc.md | 5 ++++-
atslib.md | 2 +-
7 files changed, 16 insertions(+), 13 deletions(-)
rename ATS-LF.md => ATSLF.md (55%)
rename contrib.md => Contrib.md (93%)
rename ATS-Libraries-and-C-Library-bindings.md =>
Contributed-Libraries.md (100%)

## 2. Git merge changes into translate_ja

$ git branch
* master
translate_ja
$ git checkout translate_ja
Switched to branch 'translate_ja'
Your branch is up-to-date with 'origin/translate_ja'.
$ git merge master
Auto-merging Contrib.md
Auto-merging ATSLF.md
Merge made by the 'recursive' strategy.
ATS-LF.md => ATSLF.md |
10 +++++-----
Building-and-installing.md | 4 ++--
contrib.md => Contrib.md | 6 ++----
ATS-Libraries-and-C-Library-bindings.md => Contributed-Libraries.md | 0
TODO.md | 2 ++
atsdoc.md | 5 ++++-
atslib.md | 2 +-
7 files changed, 16 insertions(+), 13 deletions(-)
rename ATS-LF.md => ATSLF.md (55%)
rename contrib.md => Contrib.md (93%)
rename ATS-Libraries-and-C-Library-bindings.md =>
Contributed-Libraries.md (100%)

## 3. Updatepo

$ make updatepo
po4a-updatepo -M utf8 -f text -m compiler-errors.md -m
Scientific-Computing.md -m Built-in-operators.md -m
Building-and-installing.md -m Internal-types.md -m tutorials.md -m
Strings.md -m safety.md -m ATSLF.md -m Stack-and-heap-allocation.md -m
Rosetta-Stone.md -m atslib.md -m Home.md -m code-generation.md -m
typechecking-errors.md -m Contributed-Libraries.md -m FAQ.md -m
dataviewtype.md -m runtime-errors.md -m staload.md -m
Built-in-constraint-solving.md -m overload.md -m char.md -m
Memory-leaks.md -m Typechecking-directives.md -m README.md -m type.md
-m effects.md -m atspkgreloc.md -m Built-in-datatypes.md -m TODO.md -m
loops.md -m dynload.md -m Error-messages.md -m Code-optimization.md -m
sort.md -m Frequently-asked-questions.md -m atsdoc.md -m template.md
-m Contrib.md -m Compiling-ATS-code.md -m Style-guide.md -p po/ja.po
........................................................................ done.
$ git diff|tail -20

#. type: Plain text
-#: char.md:37
-#, no-wrap
+#: Contrib.md:25
msgid ""
-"```ocaml\n"
-"(*\n"
-" HX: the return is dynamically allocated\n"
-"*)\n"
-"fun tostring_char\n"
-" (c: char):<> strnptr(1) = \"mac#%\"\n"
-"overload tostring with tostring_char\n"
-"```\n"
+"In order to switch between using these various packages, [[atspkgreloc|"
+"atspkgreloc]] is a useful tool that may automate the process. It can "
+"additionally be used with other repositories or forms of code storage."
msgstr ""

#. type: Plain text

## 4. Translate using gettext

$ make
po4a-translate -M utf8 -f text -k 0 -m compiler-errors.md -p po/ja.po
-l ja/compiler-errors.md
po4a-translate -M utf8 -f text -k 0 -m Scientific-Computing.md -p
po/ja.po -l ja/Scientific-Computing.md
po4a-translate -M utf8 -f text -k 0 -m Built-in-operators.md -p
po/ja.po -l ja/Built-in-operators.md
--snip--
po4a-translate -M utf8 -f text -k 0 -m Contrib.md -p po/ja.po -l ja/Contrib.md
po4a-translate -M utf8 -f text -k 0 -m Compiling-ATS-code.md -p
po/ja.po -l ja/Compiling-ATS-code.md
po4a-translate -M utf8 -f text -k 0 -m Style-guide.md -p po/ja.po -l
ja/Style-guide.md
$ git status
On branch translate_ja
Your branch is ahead of 'origin/translate_ja' by 21 commits.
(use "git push" to publish your local commits)
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)

modified: ja/Building-and-installing.md
modified: ja/Frequently-asked-questions.md
modified: ja/TODO.md
modified: ja/atsdoc.md
modified: ja/atslib.md
modified: po/ja.po

Untracked files:
(use "git add <file>..." to include in what will be committed)

ja/ATSLF.md
ja/Contrib.md
ja/Contributed-Libraries.md

no changes added to commit (use "git add" and/or "git commit -a")
$ git diff ja/Building-and-installing.md | tail
+If that does not work, it is worth trying to clean up ATSLIB as well:

make -f codegen/Makefile_atslib cleanall

The above make rule should be executed whenever one wishes to use updated
-[atslib] code from the upstream github repository.
+[ATSLIB] code from the upstream github repository.

## ATS in a virtual machine

## 5. Publish it

$ git add .
$ git commit -m update
[translate_ja 4c55ee8] update
9 files changed, 466 insertions(+), 293 deletions(-)
create mode 100644 ja/ATSLF.md
create mode 100644 ja/Contrib.md
create mode 100644 ja/Contributed-Libraries.md
$ git push
Counting objects: 58, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (57/57), done.
Writing objects: 100% (58/58), 11.82 KiB | 0 bytes/s, done.
Total 58 (delta 35), reused 0 (delta 0)
To g...@github.com:jats-ug/ATS-Postiats-wiki.git
1c3b274..4c55ee8 translate_ja -> translate_ja


Then, we can track you!

Thank's,

Kiwamu Okabe

unread,
Aug 16, 2014, 6:53:30 AM8/16/14
to ats-lang-users
Hi Brandon,

On Fri, Aug 15, 2014 at 2:40 AM, Kiwamu Okabe <kiw...@gmail.com> wrote:
> Umm... I think it has no problem. Because my work flow is:

I write a figure to explain the workflow.

https://github.com/jats-ug/ATS-Postiats-wiki/blob/translate_ja/draw/translate_flow.png

Brandon Barker

unread,
Aug 16, 2014, 12:25:39 PM8/16/14
to ats-lang-users
Thanks, that helps (also I like this style of figure). In may try in the next few days to set it up so I can track the novel jats-ug wiki additions.

I added it to an internationalization page in case other parties are interested, though I have to admit, I would be (pleasantly) surprised if it is the case in the next few years.

Also, thank you and everyone else who has started editing the wiki. I think it is starting to be a usable resource.

Brandon Barker
brandon...@gmail.com
> --
> You received this message because you are subscribed to the Google Groups "ats-lang-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to ats-lang-user...@googlegroups.com.
> To post to this group, send email to ats-lan...@googlegroups.com.
> Visit this group at http://groups.google.com/group/ats-lang-users.

Kiwamu Okabe

unread,
Aug 16, 2014, 12:32:31 PM8/16/14
to ats-lang-users
Hi Brandon,

On Sun, Aug 17, 2014 at 1:25 AM, Brandon Barker
<brandon...@gmail.com> wrote:
> I added it to an internationalization page in case other parties are
> interested, though I have to admit, I would be (pleasantly) surprised if it
> is the case in the next few years.

Ah, great.

I think anyone can translate the wiki into the other language.
Perhaps, I write the detail into internationalization page.

Thank's for your challenge,

Yannick Duchêne

unread,
Sep 28, 2014, 12:14:03 AM9/28/14
to ats-lan...@googlegroups.com


Le vendredi 8 août 2014 23:43:32 UTC+2, Brandon Barker a écrit :
In an effort to consolidate some resources around github, the new wiki can be found at:



The link to `doc/EXAMPLE/ATSLIB` ends into a 404 Error (can't fix it myself, as I don't know what the correct location is)

Hongwei Xi

unread,
Sep 28, 2014, 10:54:12 AM9/28/14
to ats-lan...@googlegroups.com
Fixed it.

--
You received this message because you are subscribed to the Google Groups "ats-lang-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ats-lang-user...@googlegroups.com.
To post to this group, send email to ats-lan...@googlegroups.com.
Visit this group at http://groups.google.com/group/ats-lang-users.

Yannick Duchêne

unread,
Sep 28, 2014, 4:36:41 PM9/28/14
to ats-lan...@googlegroups.com


Le vendredi 8 août 2014 23:43:32 UTC+2, Brandon Barker a écrit :
In an effort to consolidate some resources around github, the new wiki can be found at:


As keywords and their summarized meaning is an important entry point to the knowledge and understanding of a language (as much important as the language's grammar), I wanted to start completing the already started page on keywords. But I'm always afraid of making errors, so would feel a bit better is anyone would have even a quick review of it.

I will try to complete it again later (it's a very important page to me, and I believe, to some others too).

I feel a page for the grammar would be worth too (but I'm not sure it's actually feasible).

Yannick Duchêne

unread,
Sep 28, 2014, 4:37:40 PM9/28/14
to ats-lan...@googlegroups.com


Le dimanche 28 septembre 2014 22:36:41 UTC+2, Yannick Duchêne a écrit :


Le vendredi 8 août 2014 23:43:32 UTC+2, Brandon Barker a écrit :
In an effort to consolidate some resources around github, the new wiki can be found at:


As keywords and their summarized meaning is an important entry point to the knowledge and understanding of a language (as much important as the language's grammar), I wanted to start completing the already started page on keywords. But I'm always afraid of making errors, so would feel a bit better is anyone would have even a quick review of it.

Hongwei Xi

unread,
Sep 29, 2014, 1:24:49 PM9/29/14
to ats-lan...@googlegroups.com
Thanks for your effort!

It is a wiki, so feel free to write down what you think is the best interpretation of these keywords.

--
You received this message because you are subscribed to the Google Groups "ats-lang-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ats-lang-user...@googlegroups.com.
To post to this group, send email to ats-lan...@googlegroups.com.
Visit this group at http://groups.google.com/group/ats-lang-users.

Brandon Barker

unread,
Oct 2, 2014, 9:17:12 AM10/2/14
to ats-lang-users
I re-cloned the wiki at https://github.com/bbarker/ATS-Postiats-wiki, mainly as a convenient place to view diffs. Previously, the diffs were pretty bad at times due to not handling end-of-lines correctly in the merge, but this should no longer be an issue.

Brandon Barker

unread,
Oct 2, 2014, 9:20:36 AM10/2/14
to ats-lang-users
Well, I spoke too soon, the diffs still look pretty bad, but I don't know why.
--
Brandon Barker
brandon...@gmail.com

Brandon Barker

unread,
Oct 3, 2014, 11:35:00 AM10/3/14
to ats-lang-users
I've added a C interface article, which is at https://github.com/githwxi/ATS-Postiats/wiki/C-interface

It should be fairly complete (but I'm sure there is at least something worth saying that is probably forgotten), so if you happen to look at it and see anything missing or any inaccuracies, let's try to fix it.

Thanks,
--
Brandon Barker
brandon...@gmail.com
Reply all
Reply to author
Forward
0 new messages