|
| 1 | +# Officiële documentatie van Perl 6 |
| 2 | + |
| 3 | +[](https://travis-ci.org/perl6/doc) [](https://opensource.org/licenses/Artistic-2.0) |
| 4 | + |
| 5 | +[](https://app.shippable.com/github/perl6/doc) |
| 6 | + |
| 7 | +Een HTML-versie van deze documentatie is te vinden onder [https://docs.perl6.org/](https://docs.perl6.org/); |
| 8 | +dit is momenteel de aanbevolen manier om de documentatie te raadplegen. Daarnaast bestaat er voor het raadplegen |
| 9 | +van de documentatie ook een command line tool genaamd "p6doc". |
| 10 | + |
| 11 | +NOOT: Als je door deze repository bladert met behulp van GitHub, dan zullen de meeste bestanden niet correct |
| 12 | +worden weergegeven omdat ze zijn opgemaakt in Perl 6 Pod, terwijl GitHub ze interpreteert als Perl 5 Pod. |
| 13 | + |
| 14 | +## README in andere talen |
| 15 | + |
| 16 | +* [README in het Chinees](README.zh.md) |
| 17 | +* [README in het Duits](README.de.md) |
| 18 | +* [README in het Italiaans](README.it.md) |
| 19 | +* [README in het Spaans](README.es.md) |
| 20 | +* [README in het Frans](README.fr.md) |
| 21 | + |
| 22 | +## Het installeren van p6doc |
| 23 | + |
| 24 | +Deze module is beschikbaar via het Perl 6 module-ecosysteem. Geef het commando: |
| 25 | + |
| 26 | + $ zef install p6doc |
| 27 | + |
| 28 | +om het p6doc programma te installeren, en het beschikbaar te maken via het zoekpad. |
| 29 | + |
| 30 | +## Het gebruik van p6doc |
| 31 | + |
| 32 | +Geef, met een uitvoerbaar Rakudo `perl6` bestand in het zoekpad `PATH`, het commando: |
| 33 | + |
| 34 | + $ ./bin/p6doc Str |
| 35 | + |
| 36 | +om de documentatie voor klasse `Str` te bekijken, of het commando: |
| 37 | + |
| 38 | + $ ./bin/p6doc Str.split |
| 39 | + |
| 40 | +om de documentatie voor methode `split` in klasse `Str` in te zien. Je kunt |
| 41 | +het `./bin/`-deel achterwege laten als je Rakudo met behulp van `zef` hebt geïnstalleerd. |
| 42 | +Je kunt ook het commando: |
| 43 | + |
| 44 | + $ p6doc -f slurp |
| 45 | + |
| 46 | +gebruiken om door de documentatie van de standaardfuncties te bladeren. De snelheid hierbij is |
| 47 | +afhankelijk van je schijfsnelheid en Rakudoversie. |
| 48 | + |
| 49 | +------- |
| 50 | + |
| 51 | +## Het genereren van de HTML-documentatie |
| 52 | + |
| 53 | +Installeer de benodigde dependencies door het volgende commando uit te voeren in de checkout directory: |
| 54 | + |
| 55 | + $ zef --deps-only install . |
| 56 | + |
| 57 | +Als je gebruik maakt van [`rakudobrew`](https://github.com/tadzik/rakudobrew) heb je ook |
| 58 | +het volgende commando nodig om de shims voor de geïnstalleerde programma's te updaten: |
| 59 | + |
| 60 | + $ rakudobrew rehash |
| 61 | + |
| 62 | +Naast de Perl 6 dependencies dien je ook 'graphviz' geïnstalleerd te hebben; op Debian kun |
| 63 | +je dit bewerkstelligen met het commando: |
| 64 | + |
| 65 | + $ sudo apt-get install graphviz |
| 66 | + |
| 67 | +Om de documentatiewebpagina's te genereren geef je simpelweg het volgende commando: |
| 68 | + |
| 69 | + $ make html |
| 70 | + |
| 71 | +Merk op dat je [nodejs](https://nodejs.org) geïnstalleerd dient te hebben om HTML pagina's |
| 72 | +te kunnen genereren met het bovenstaande commando. In het bijzonder dient het uitvoerbare |
| 73 | +`node` bestand via het zoekpad `PATH` vindbaar te zijn. Daarnaast moet ook `g++` zijn |
| 74 | +geïnstalleerd om enkele dependencies die samen met nodejs zijn geïnstalleerd te compileren. |
| 75 | +nodejs is overigens alleen nodig voor het highlighten van opgenomen codefragmenten. Als |
| 76 | +dit niet vereist of gewenst is, dan volstaat het commando: |
| 77 | + |
| 78 | + $ make html-nohighlight |
| 79 | + |
| 80 | +Na het genereren van de pagina's kun je ze lokaal op je computer bekijken door het starten van |
| 81 | +het meegeleverde `app.pl`-programma: |
| 82 | + |
| 83 | + $ make run |
| 84 | + |
| 85 | +Je kunt de documentatie dan bekijken door je webbrowser te verwijzen naar [http://localhost:3000](http://localhost:3000). |
| 86 | + |
| 87 | +Je dient ten minste [Mojolicious](https://metacpan.org/pod/Mojolicious) te hebben geïnstalleerd, en |
| 88 | +voor syntax highlighting is ook [nodejs](https://nodejs.org) nodig. Eventuele andere modules die je |
| 89 | +nodig zou kunnen hebben kun je allemaal installeren middels het commando: |
| 90 | + |
| 91 | + $ cpanm --installdeps . |
| 92 | + |
| 93 | +--------- |
| 94 | + |
| 95 | +## Hulp gevraagd! |
| 96 | + |
| 97 | +Perl 6 is geen kleine taal en het documenteren ervan is dan ook een hele onderneming. |
| 98 | +Alle hulp daarbij is van harte welkom, en wordt zeer gewaardeerd. |
| 99 | + |
| 100 | +Dit zijn enkele manieren waarop je ons zou kunnen helpen: |
| 101 | + |
| 102 | + * Voeg ontbrekende documentatie toe voor klassen, rollen, methoden of operatoren. |
| 103 | + * Voeg gebruiksvoorbeelden toe aan bestaande documentatie. |
| 104 | + * Controleer en verbeter bestaande documentatie. |
| 105 | + * Wijs ons op ontbrekende documentatie door het openen van een issue op GitHub. |
| 106 | + * Doe een `git grep TODO` in deze repository, en vervang de TODO items door daadwerkelijke documentatie. |
| 107 | + |
| 108 | + |
| 109 | +De [issues pagina](https://github.com/perl6/doc/issues) bevat een lijst van openstaande issues evenals een overzicht |
| 110 | +van documentatieonderdelen waarvan bekend is dat ze ontbreken. Het [CONTRIBUTING dokument](CONTRIBUTING.md) legt |
| 111 | +beknopt uit hoe je desgewenst kunt beginnen bij te dragen aan de documentatie. |
| 112 | + |
| 113 | +-------- |
| 114 | + |
| 115 | +## Een paar kanttekeningen: |
| 116 | + |
| 117 | +**Q:** Waarom wordt de documentatie niet geëmbed in de CORE broncode?<br> |
| 118 | +**A:** Hiervoor bestaat een aantal redenen: |
| 119 | + |
| 120 | + 1. Deze documentatie beoogt universeel te zijn ten aanzien van een |
| 121 | + gegeven versie van de specificatie, en is dus niet noodzakelijkerwijs |
| 122 | + verbonden aan een specifieke Perl 6 implementatie. |
| 123 | + 2. De verwerking van geëmbedde Pod door implementaties is vooralsnog |
| 124 | + niet volkomen vlekkeloos; afzonderlijke documentatie voorkomt dus |
| 125 | + potentiële runtime-complicaties. |
| 126 | + 3. Een aparte repository onder de perl6 GitHub-account werkt drempelverlagend, |
| 127 | + en nodigt meer mensen uit bij te dragen en teksten te bewerken. |
| 128 | + |
| 129 | +**Q:** Kan ik ook bijdragen door methoden van superklassen of rollen op te nemen?<br> |
| 130 | +**A:** Nee. De HTML-versie omvat op dit moment al methoden van superklassen en |
| 131 | + rollen, en het `p6doc`-script zal hieraan worden aangepast. |
| 132 | + |
| 133 | +-------- |
| 134 | + |
| 135 | +## Visie |
| 136 | + |
| 137 | +> Ik wens dat p6doc en docs.perl6.org het nummer 1-naslagwerk worden dat |
| 138 | +> geraadpleegd kan worden wanneer je iets wilt weten over een Perl 6 feature, |
| 139 | +> of dit nu behoort tot de taal zelf, of tot de ingebouwde typen en functies. |
| 140 | +> Ik wil dat het van praktisch nut is voor iedere Perl 6-programmeur. |
| 141 | +> |
| 142 | +> -- moritz |
| 143 | +
|
| 144 | +-------- |
| 145 | + |
| 146 | +# Omgevingsvariabelen |
| 147 | + |
| 148 | +- Geef `P6_DOC_TEST_VERBOSE` een `true`-waarde om gedurende het doorlopen van de test suite uitvoerige meldingen weer te geven. |
| 149 | +Dit is behulpzaam tijdens het debuggen van de test suite. |
| 150 | +- `P6_DOC_TEST_FUDGE` zet `skip-test` codevoorbeelden om in TODO in `xt/examples-compilation.t` test. |
| 151 | + |
| 152 | +# LICENTIE |
| 153 | + |
| 154 | +De code in deze repository is beschikbaar onder de Artistic License 2.0 zoals gepubliceerd door The |
| 155 | +Perl Foundation. Zie het [LICENSE](LICENSE) bestand voor de volledige tekst. |
| 156 | + |
| 157 | +Deze repository bevat ook code die is geschreven door derde partijen en die onder een afwijkende licentie beschikbaar is gemaakt. |
| 158 | +De betreffende bestanden vermelden het auteursrecht en de licentievoorwaarden aan het begin. Momenteel omvat deze categorie bestanden: |
| 159 | + |
| 160 | +* jQuery and jQuery UI libraries: Copyright 2015 jQuery Foundation and other contributors; [MIT License](http://creativecommons.org/licenses/MIT) |
| 161 | +* [jQuery Cookie plugin](https://github.com/js-cookie/js-cookie): |
| 162 | + Copyright 2006, 2015 Klaus Hartl & Fagner Brack; |
| 163 | + [MIT License](http://creativecommons.org/licenses/MIT) |
| 164 | +* Examples from Stack Overflow [MIT License](http://creativecommons.org/licenses/MIT); ([ref #1](http://stackoverflow.com/a/43669837/215487) for [1f7cc4e](https://github.com/perl6/doc/commit/1f7cc4efa0da38b5a9bf544c9b13cc335f87f7f6)) |
| 165 | +* Table sorter plugin from https://github.com/christianbach/tablesorter ; |
| 166 | + [MIT License](http://creativecommons.org/licenses/MIT) |
0 commit comments