asker-tool 2.1.2 → 2.1.7

data/docs/commands.md

@@ -1,15 +0,0 @@
-
-[<<back](../README.md)
-
-# Commands
-
-By now, ASKER run as CLI command.
-
-| Command                 | Description                     |
-| ----------------------- | ------------------------------- |
-| asker                   | Show available functions        |
-| asker version           | Show current version            |
-| asker PATH/TO/INPUTFILE | Create questions for input file |
-| asker file PATH/TO/INPUTFILE | File keyword is optional   |
-| asker check PATH/TO/INPUTFILE | Check HAML file syntax    |
-| asker init              | Create default config.ini file  |

data/docs/contributions.md

@@ -1,18 +0,0 @@
-
-[<< back](../README.md)
-
-# Contributions
-
-If you want to contribute:
-* Talk about this tool with your colleagues.
-* Use this tool.
-* Report bugs.
-* Report us, your ideas for new features.
-* Share with us your own input files.
-* And if you love `ruby`, you can develop with us or work on the issues.
-
----
-# Contact
-
-* **Email**: `teuton.software@protonmail.com`
-* **Twitter**: `@SoftwareTeuton`

data/docs/history.md

@@ -1,40 +0,0 @@
-
-[<< back](../README.md)
-
-# History
-
-> Some time ago, this project was called "Darts of teacher". We renamed it because "darts" was used. Now, it's called ASKER.
-
-## The problem
-
-Working as a teacher, one of the most boring taks is check the same exercises
-again and again, for every student, and every year.
-
-The tests questions allow us to make activities that are automaticaly checked/resolved by software tools, as for example, Moodle cuestionairs.
-In this case, the teacher will have enough time to waste others tasks, as:
-* Analise results with detail.
-* Read information about others materials.
-* Test new aplications.
-* Develop new tools.
-* Etc.
-
-In resume, applying more new knowledge to improve his work,
-trying new ways of doing his job better, finding or redefining activities or lessons contents. Just finding a better way of teaching. And an easier way of learning for the students.
-
-## Need a new tool
-
-I decide (about 2013) start writing this tool to help me
-with the process of making test questions from input definition files.
-
-With this tool, I only waste time making this input file.
-As a teacher I have this knowledge into my mind, so it will be easy.
-It's the resume, definitions or conceptual entities of the unit
-I'm teaching.
-
-I've been using this tools several years/courses, teaching computer
-science. I have a lot of work to improve it and new features to add.
-It's usefull (for me at least), and hope It'll be for you too.
-
-;-)
-
-David Vargas

data/docs/idea.md

@@ -1,44 +0,0 @@
-
-[<< back](../README.md)
-
-# Basics
-
-> **Disclaimber**
->
-> I work as a teacher, and I try to do the best I know. But I'm really a programmer. I studied Computer Science at *ULPGC*.
->
-> The 90% of what I've learned, I must thank to *Open Source* community.
-The other 10%, It's luck and time wasted working.
-
-## Open vs closed problems
-
-The big problem with test questions are that only are usefull to evaluate
-measurable features. So it is useless when we try measure abstract
-features or measure open problems. But I think, we can do it with another approach.
-
-I mean, if we get an open and abstract problem, their resolution will consist on several steps or measurable milestones. So we can transform an open problem, into a lot of closed mini-problems. And we have to focus on the measurable aspects.
-
-Besides, if I *"bomb"* the student with a huge amount of diferent test questions about one concept, probably I could be near of knowing and measuring, the student asimilation of that kownledge.
-
-## Making Questions
-
-The task of creating test questions to solve the previous problem, becames another different problem to be solved. When I had to make manually this test questions, it took me a lot of time. And I need a lot.
-
-And usually when I was making the question number 42, I realise that I forgot the content of the 41 previous. I'm loosing time and it's slow.
-
-## Work once
-
-Finally, I decide to write this tool that help me with the process of
-making test questions from input definition files.
-
-So I only waste time making an input file. But as a teacher I have this
-into my mind and it must be a simple job. Because the inpu file it's just a resumed concepts list about the unit I'm teaching.
-
-I've been using this tools several years/courses, teaching computer
-science. I have a lot of functions to be improved and features to be added.
-But for now, It's usefull (for me at least), and hope it will be for you too.
-;-)
-
-_Thanks!_
-
-David Vargas

data/docs/inputs/README.md

@@ -1,39 +0,0 @@
-
-[<< back](../../README.md)
-
-# Inputs
-
----
-
-## Text plain editor
-
-How to build our asker input files?
-
-Open a plain text editor and start writting definitions.
-* [Learn about concepts](concepts.md)
-* [Learn about tables](tables.md)
-* [Learn about templates](templates.md)
-* [Learn about code](code.md)
-
----
-
-## Web editor (On development)
-
-Asker has a web editor to help building our asker input files.
-By now only read, do not write. Sorry! Still is on development.
-
-Looks like this:
-
-![](../images/web-editor.png)
-
-To launch web editor:
-1. `asker editor`
-1. Open web browser and goto URL `localhost:4567`.
-
----
-
-## More examples
-
-Download our git repository with a lot of examples:
-* `asker donwnload` or
-* `git clone https://github.com/dvarrui/asker-inputs.git`

data/docs/inputs/code.md

@@ -1,69 +0,0 @@
-
-[<< back](README.md)
-
-# Learn code
-
-Now, we are going to learn experimental keywords:
-* code
-
----
-
-# Concept limits
-
-We have learn about using: map, concept, names, tags, def, table and template keywords. All them are usefull to define concepts.
-
-Commonly we use natural lenguages (en, es, fr, de, etc) to talk about them and Asker DSL is a simpler and structured language version. All languages are similar (verbs, subjects, adjective, etc.), but have their own rules.
-A poem, for example is writting using those rules.
-
-Exists others kind of human creations, that use other definition languages.
-For example, programming languages, file configurations, drawing language, math language, etc,
-
-So we had to create new DSL keyword called `code`.
-
-Let's see.
-
----
-# Code
-
-## Example
-
-Example, using `code`keyword to define a python program from `files/string.py`file:
-
-```
-%map{ :version => '1', :lang => 'en', :context=>'python, programming, language' }
-
-  %code
-    %type python
-    %path files/string.py
-```
-
-| Param | Description               |
-| ----- | ------------------------- |
-| code  | Define a new code concept |
-| type  | Content type              |
-| path  | Path to content file |
-
-> Experimental type values: python, ruby, javascript, sql
-
-## Full map
-
-Example, using `code`keyword to define several python programs from `files/` folder:
-
-```
-%map{ :version => '1', :lang => 'en', :context=>'python, programming, language' }
-
-  %code
-    %type python
-    %path files/string.py
-
-  %code
-    %type python
-    %path files/array.py
-
-  %code
-    %type python
-    %path files/iterator.py
-```
-
-Example:
-* [python](../examples/code)

data/docs/inputs/concepts.md

@@ -1,142 +0,0 @@
-
-[<< back](README.md)
-
-# Learn basics
-
-To know how to build our asker input files, we need to learn
-main keywords:
-* map
-* concept
-* names
-* tags
-* def
-
-Let's start!.
-
----
-
-# Text plain editor
-
-* Create a text file, called for example: `demo/furniture.haml`.
-* **map**: Once, at first line, we write keyword `map`. Example:
-
-```ruby
-%map{ :lang => 'en', :context => 'furniture, home', :version => '1'}
-```
-
-| Attribute | Description                                    |
-| --------- | ---------------------------------------------- |
-| lang      | Output texts will be created in English. Valid values: en, es |
-| context   | Comma separated labels that define map content |
-| version   | Input file format version. Valid value: 1 |
-
-This input file will contain concepts about furniture context.
-Use diferents input files to define diferents contexts.
-
-> Use separated contexts is good idea. Sometimes, diferents concept from diferents contexts has the same `names` value. For example:
-> * free as free of charge, costless.
-> * free as in freedom.
-
-* **concept, names, tags**: So we define our first concept:
-
-```
-  %concept
-    %names chair
-    %tags single, seat, leg, backrest
-```
-
-| Param | Description                     |
-| ----- | ------------------------------- |
-| names | Comma separated concept's names |
-| tags  | Comma separated tags that help to identify this concept |
-
-* **def**: Use def keyword to add concept meaning. The `def` content must uniquely identifies our concept. You can use `def` more than once.
-
-```
-  %concept
-    %names chair
-    %tags single, seat, leg, backrest
-    %def Single seat with legs and backrest
-    %def Furniture that is placed around the table to sit
-```
-
-At this time, we may generate questions with:
-
-```bash
-asker demo/furniture.haml
-```
-
----
-
-# Formats
-
-HAML is a special format. It's necesary write exactly:
-* 0 spaces before map.
-* 2 spaces before concept.
-* 4 spaces before names, tags and def.
-
-It's posible write the same using XML format instead. Take a look:
-
-```xml
-<map lang='en' context='furniture, home' version='1'>
-  <concept>
-    <names>chair</names>
-    <tags>single, seat, leg, backrest</tags>
-    <def>Single seat with legs and backrest</def>
-    <def>Furniture that is placed around the table to sit</def>
-  </concept>
-</map>
-```
-
-Notice that `demo/furniture.haml` is HAML file and  `demo/furniture.xml` a XML file. Both are valid.
-
-> HAML format files are the same as XML format files.
-Internaly HAML files are translated automaticaly to an XML equivalent.
->
-> Why write into HAML instead of XML? HAML It's easier (for me).
-You don't have to close every tag, only be carefuly with indentation.
->
-> If you prefer, you could write your input files using XML.
-
----
-
-# Adding images
-
-Example:
-![](https://www.portobellostreet.es/imagenes_muebles/Muebles-Silla-colonial-Fusta-Bora-Bora.jpg)
-
-**def** can be used with image URL. So we have to find an image that uniquely identifies our concept and write this:
-
-```
-    %def{:type => 'image_url'}https://www.portobellostreet.es/imagenes_muebles/Muebles-Silla-colonial-Fusta-Bora-Bora.jpg
-```
-
-| Attribute | Description  |
-| --------- | ------------ |
-| type      | Content type |
-
----
-
-# Increase questions number
-
-Adding more concepts will increase questions number generated by ASKER:
-
-```
-  %concept
-    %names couch
-    %tags furniture, seat, two, threee, people, bench, armrest
-
-  %concept
-    %names table
-    %tags furniture, flat, top, leg, surface, work, eat
-
-  %concept
-    %names bed
-    %tags furniture, place, sleep, relax
-```
-
-Examples:
-* [furniture.haml](../examples/home/furniture.haml)
-* [furniture.xml](../examples/home/xml/furniture.xml)
-
-[>> Learn about tables](tables.md)

data/docs/inputs/jedi.md

@@ -1,68 +0,0 @@
-
-# Jedi
-
-Inputs
-======
-
-Into *maps* directory we save our own concept map files. We could use subdirectories to
-better organization. As example we have the file `maps/demo/starwars/jedi.haml`, that
-contains one concept map about Jedi characters of StarWars film into HAML format.
-
-Let's take a look (Spanish example, I know. Soon I'll write the english version):
-```
-%map{ :lang => 'en', :context => 'character, starwars', :version => '1'}
-
-  %concept
-    %names obiwan
-    %tags jedi, teacher, annakin, skywalker, pupil, quigon-jinn
-    %def Jedi, teacher of Annakin  Skywalker
-    %def Jedi, pupil of Quigon-Jinn
-    %table{ :fields => 'attribute, value' }
-      %title Associate every attribute with their value
-      %row
-        %col race
-        %col human
-      %row
-        %col laser sabel color
-        %col green
-      %row
-        %col hair color
-        %col red
-
-  %concept
-    %names yoda
-    %tags teacher, jedi
-    %def Jedi, teacher of all jedis
-    %def The Main Teacher of Jedi and one of the most important members of the Main Jedi Council, in the last days of Star Republic.
-    %def He has exceptional combat abilities with light sable, using acrobatics tecnics from Ataru.
-    %def He was master of all light sable combat styles and was considered during years as a Sword Master.    
-    %table{ :fields => 'attribute, value' }
-      %row
-        %col color laser sabel
-        %col green
-      %row
-        %col hair color
-        %col white
-      %row
-        %col skin color
-        %col green
-      %row
-        %col high
-        %col 65 centimetres
-...
-```
-As we see, we defined 2 concepts about Jedi characters. This are `obiwan` and `yoda`.
-And we use special sintax (tags) to define it.
-
-At now we have a this list of tags to define our own sintax for build conceptual maps:
-* **context**: List of comma separated words, that identify the context where this concept "lives" or "exists".
-* **names**: List of one or more names that identify the concept. At least one is requiered, of course!.
-* **tags**: List of comma separated words, that briefly describe the concept. I mean, a short list of words
-that came in mind when we think in it, and are useful for their identification.
-* **def**: We use this tags as many times we need. In it, we write using natural language descriptions
-asssociated to the concept. This are definitions/descriptions that are uniques
-for this concept, but don't write the name of the concept into the text.
-* **table**: Other way to build more sofisticated definitions/schemas is using "tables". It's similar
-to HTML tag. I mean, with this "table", we build tables of knowledge into the concept. We use "row",
-and "col", to defines table-rows and row-cols, of course. We could see an
-example into `input/en/starwars/jedi.haml`.

data/docs/inputs/tables.md

@@ -1,112 +0,0 @@
-
-[<< back](README.md)
-
-# Learn tables
-
-Now, we are going to learn keywords:
-* table
-* row
-* col
-
-Let's go!.
-
----
-
-# Def limits
-
-We have learn that:
-* **map** serves to identify an input file.
-* **concept**, **names** and **tags** serves to identify a concept.
-* **def** serves to add meaning to a concept.
-
-But, it's not enough. **def** only contains meaning that could only be associated to one unique concept. For example:
-```
-  %concept
-    %names AC/DC, ACDC
-    %tags rock, band, australia
-    %def Australian rock band formed by Scottish-born brothers Malcolm and Angus Young
-```
-
-**def** is good but we need other keyword to add meaning that isn't uniquely associated to one concept. That is **table** keyword.
-
----
-# Tables
-
-## Table with 1 field
-
-Example, adding meaning using 1 field table. Field called `members`:
-
-```
-%concept
-  %names AC/DC, ACDC
-  %tags single, seat, leg, backrest
-  %tags rock, band, australia
-  %table{ :fields => 'members'}
-    %row Bon Scott
-    %row Angus Young
-    %row Malcolm Young
-    %row Phil Rudd
-    %row Cliff Williams
-```
-
-| Param  | Description |
-| ------ | ----------- |
-| table  | Group rows  |
-| fields | Comma separated values with field name |
-| row    | Field value |
-
-## Table with 2 fields
-
-Example, adding meaning using 2 fields table. Fields called `attribute` and `value`:
-
-```
-  %concept
-    %names AC/DC, ACDC
-    %tags single, seat, leg, backrest
-    %tags rock, band, australia
-    %table{ :fields => 'attribute, value'}
-      %row
-        %col Genres
-        %col Hard rock blues rock rock and roll
-      %row
-        %col Years active
-        %col 1973–present
-      %row
-        %col Origin
-        %col Sydney
-```
-
-| Param  | Description        |
-| ------ | ------------------ |
-| table  | Group rows         |
-| fields | Comma separated values with field names |
-| row    | Group cols         |
-| col    | Field column value |
-
-## Table with Sequence
-
-Sometimes we have a 1 field table where rows are sorted or form a sequence. In that cases we also could take advantage defining a `sequence`, like:
-
-```
-%concept
-  %names AC/DC, ACDC
-  %tags single, seat, leg, backrest
-  %tags rock, band, australia
-  %table{ :fields => 'Albums', :sequence => 'Albums sorted by date'}
-    %row Albums High Voltage
-    %row Powerage
-    %row Highway to Hell
-    %row Back in Black
-    %row Ballbreaker
-    %row Rock or Bust
-```
-
-| Param    | Description        |
-| -------- | ------------------ |
-| table    | Group rows         |
-| fields   | Field name         |
-| sequence | Label form ordered values |
-| row      | Field value        |
-
-Example:
-* [acdc.haml](../examples/bands/acdc.haml)