Difference between revisions of "Documentation"
From Clean
Jump to navigationJump to searchBas Lijnse (talk | contribs) (Added intention description for this page) |
(add link to the language report) |
||
| (24 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | __NOTOC__ | |
| + | == Clean language report == | ||
| + | The language report (versions 1.3 and 2.0) written by Rinus Plasmeijer and Marko van Eekelen (University of Nijmegen) is the reference manual for the Clean programming language. | ||
| + | |||
| + | It is a must for anyone who wants to write serious Clean applications. | ||
| + | |||
| + | === Latest version === | ||
| + | An automatically built version of the language report (including pdf and html versions) can always be found here: [ftp://ftp.cs.ru.nl/pub/Clean/builds/windows-x64/clean-language-report-windows-x64-latest.zip zip]/[ftp://ftp.cs.ru.nl/pub/Clean/builds/linux-x64/clean-language-report-linux-x64-latest.tgz tgz]. | ||
| + | |||
| + | === All versions === | ||
| + | {| style="background: #7fc0e9; border: 1px solid #fff; padding: 10px;" | ||
| + | !Clean Version || PDF || Html || Postscript || Word | ||
| + | |- | ||
| + | |2.2 || [http://clean.cs.ru.nl/download/doc/CleanLangRep.2.2.pdf 2.1M] || [http://clean.cs.ru.nl/download/html_report/CleanRep.2.2_1.htm multi-page] || - || - | ||
| + | |- | ||
| + | |2.1 || [http://clean.cs.ru.nl/download/Clean20/doc/CleanLangRep.2.1.pdf 1.8M] || - || - || - | ||
| + | |- | ||
| + | |2.0 || [http://clean.cs.ru.nl/download/Clean20/doc/CleanRep2.0.pdf 2M] || - || - || - | ||
| + | |- | ||
| + | |1.3.1 || [http://www.sws.cs.ru.nl/publications/papers/cleanmanual/CleanRep.1.3.1.pdf.zip 661K] || - || [http://www.sws.cs.ru.nl/publications/papers/cleanmanual/CleanRep.1.3.1.ps.zip 1432K] || [http://www.sws.cs.ru.nl/publications/papers/cleanmanual/CleanRep.1.3.1.doc.zip 275K] | ||
| + | |- | ||
| + | |1.3 || [http://clean.cs.ru.nl/download/Clean13/doc/refman13.pdf.gz 309K] || - || [http://clean.cs.ru.nl/download/Clean13/doc/refman13.ps.gz 319K] || [http://clean.cs.ru.nl/download/Clean13/doc/refman13.rtf.gz 377K] | ||
| + | |- | ||
| + | |1.1 || [http://clean.cs.ru.nl/download/Clean11/doc/refman11.pdf.gz 455K] || - || [http://clean.cs.ru.nl/download/Clean11/doc/refman11.ps.gz 669K] || [http://clean.cs.ru.nl/download/Clean11/doc/refman11.rtf.gz 591K] | ||
| + | |} | ||
| + | |||
| + | == Clean books == | ||
| + | There are several books about Clean: | ||
| + | * [[Functional Programming in Clean]] is a practical book in progress intended as an introduction to functional programming in Clean for undergraduate students. It is available online. | ||
| + | * [[Functional Programming and Parallel Graph Rewriting]] is a book that describes the theoretical foundation and implementation of Clean. It has been published by Addison Wesley in 1993. | ||
| + | * [http://www.discenda.org/Clean/ Programming in Clean] is a nice Clean book for beginners. It is available online. | ||
| + | |||
| + | == Libraries == | ||
| + | Documents concerning Clean libraries: | ||
| + | * A Concise Guide to Clean 3.x StdEnv ([[File:ConciseGuideToClean3xStdEnv.pdf]]) gives an overview of the StdEnv library of Clean '''3'''.x | ||
| + | * A Concise Guide to Clean 2.x StdEnv ([[File:ConciseGuideToClean2xStdEnv.pdf]]) gives an overview of the StdEnv library of Clean '''2'''.x | ||
| + | * [http://clean.cs.ru.nl/download/supported/ObjectIO.1.2/doc/tutorial.pdf A Tutorial to the Clean Object I/O Library - Version 1.2.] gives a comprehensive overview of the Object I/O library of Clean. Please note that this document is included in every Windows distribution (check out help). | ||
| + | |||
| + | == Community documentation == | ||
| + | |||
| + | [https://top-software.nl TOP Software] maintains some documentation at [https://top-software.gitlab.io/clean-lang/ top-software.gitlab.io/clean-lang] to which anyone can contribute. | ||
| + | |||
| + | == Cloogle == | ||
| + | [https://cloogle.org Cloogle] is the official Clean search engine that indexes all standard libraries, external libraries, compiler errors, ABC instructions, builtins and syntax elements. | ||
Latest revision as of 09:11, 23 March 2021
Clean language report
The language report (versions 1.3 and 2.0) written by Rinus Plasmeijer and Marko van Eekelen (University of Nijmegen) is the reference manual for the Clean programming language.
It is a must for anyone who wants to write serious Clean applications.
Latest version
An automatically built version of the language report (including pdf and html versions) can always be found here: zip/tgz.
All versions
| Clean Version | Html | Postscript | Word | |
|---|---|---|---|---|
| 2.2 | 2.1M | multi-page | - | - |
| 2.1 | 1.8M | - | - | - |
| 2.0 | 2M | - | - | - |
| 1.3.1 | 661K | - | 1432K | 275K |
| 1.3 | 309K | - | 319K | 377K |
| 1.1 | 455K | - | 669K | 591K |
Clean books
There are several books about Clean:
- Functional Programming in Clean is a practical book in progress intended as an introduction to functional programming in Clean for undergraduate students. It is available online.
- Functional Programming and Parallel Graph Rewriting is a book that describes the theoretical foundation and implementation of Clean. It has been published by Addison Wesley in 1993.
- Programming in Clean is a nice Clean book for beginners. It is available online.
Libraries
Documents concerning Clean libraries:
- A Concise Guide to Clean 3.x StdEnv (File:ConciseGuideToClean3xStdEnv.pdf) gives an overview of the StdEnv library of Clean 3.x
- A Concise Guide to Clean 2.x StdEnv (File:ConciseGuideToClean2xStdEnv.pdf) gives an overview of the StdEnv library of Clean 2.x
- A Tutorial to the Clean Object I/O Library - Version 1.2. gives a comprehensive overview of the Object I/O library of Clean. Please note that this document is included in every Windows distribution (check out help).
Community documentation
TOP Software maintains some documentation at top-software.gitlab.io/clean-lang to which anyone can contribute.
Cloogle
Cloogle is the official Clean search engine that indexes all standard libraries, external libraries, compiler errors, ABC instructions, builtins and syntax elements.
