Giter Club home page Giter Club logo

tablets's Introduction

Overview

These are the Perl Tablets, a lexicon style documentation for Perl 6 written in Pandoc-Markdown and optimized for hypertext formats.

They are available online at http://tablets.perl6.org.

How to Help

Beginner

  • Fix typos and spelling by editing directly on github with the editor widget.

  • Add entries to FAQ (Appendix F) and glossary (Appendix G).

  • Just start reading and report issues if you're not sure.

  • Please pore over Appendix B taking note of the various links to the main Index (Appendix A). When you see a Perl 6 term without a link, find its corresponding anchor in the Index, then (in Appendix B) create a link to it.

Advanced

  • Several items in FAQ and the glossary (works mostly without P6 knowledge) are still unexplained.

  • The Tablet 1: History needs a lot of help, especially information from people who were involved in the subprojects.

  • Running the report.pl will you give you hints about current things to do.

Formating Rules

Anchor Names

  • Index A has following rules:
  • Anchors are case sensitive, if the term is "BEGIN", the anchor is also "BEGIN".
  • Parts of the anchor name are divided by a minus ("-").
  • None alphanumeric chars are descibed as lowercase name.
  • But use for that only one word, "=" is "equal" not "equal sign".
  • "==" is equal-equal, "===" is "equal-equal-equal"
  • A secondary anchor can dexribe the name of an operator.
  • Index G has following rules:
  • Anchor uses always the abbreviation, acronym or short form.
  • Acronyms are uppercase rest is always lower case.

Highlighting

  • Perl 6 builtins (links to A) are bold (**...**)
  • terms (links to G) and Perl 5 builtins are italic (*...*)
  • code snipptes are in (`...`)
  • markdown for formating linked text please inside the square brackets
  • between item name, its explanation and additional infos is an — (—)

Handling

Getting your copy

Just clone the repo per git and install pandoc.

Generating the html

After updating any .txt files, to regenerate the corresponding html files, run ./build-html.pl in the docs directory.

Publishing the Tablets

scp the docs/*.html files and the styles.css file to the web.

LICENSE

Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)

http://creativecommons.org/licenses/by-sa/3.0/deed.en

CONTRIBUTORS

tablets's People

Contributors

cowens avatar gerdr avatar jonathanstowe avatar kmetcalf avatar lichtkind avatar moritz avatar pmichaud avatar raiph avatar s-h-r-i avatar samlh avatar siddhant avatar szabgab avatar zmughal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.