asker-tool 2.1.3 → 2.1.5

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)

data/docs/inputs/templates.md

@@ -1,87 +0,0 @@
-
-[<< back](README.md)
-
-# Learn templates
-
-Now, we are going to learn `template` keyword.
-
----
-
-# Powerfull tables
-
-Table is usefull keyword to add information associated to concepts using table struct (That means with rows and columns scheme).
-
-## Example 01: repetitive rows
-
-Let's see this repetitive row example about OS commands:
-
-```
-  %concept
-    %names command
-    %tags computing,directive,computer,perform,specific,task
-    %def In computing, is a directive to a computer program to perform a specific task.
-    %table{:action, :description}
-      %row
-        %col mkdir Endor
-        %col Create Endor directory
-      %row
-        %col mkdir Naboo
-        %col Create Naboo directory
-      %row
-        %col mkdir Dagobah
-        %col Create Dagobah directory
-```
-
-## Example 02: Using template
-
-To be more productive, we could use `template` keyword.
-
-```
-  %concept
-    %names command
-    %tags computing,directive,computer,perform,specific,task
-    %def In computing, is a directive to a computer program to perform a specific task.
-    %table{:action, :description}
-      %template{:DIRNAME => 'Endor,Naboo,Dabobah'}
-        %row
-          %col mkdir DIRNAME
-          %col Create DIRNAME directory
-```
-
-We see example 01 produce the same result, but with less input lines.
-Template will be apply to every definition inside.
-
-| Param    | Description |
-| -------- | ----------- |
-| template | Begin template definition |
-| DIRNAME | Token o variable that will be replaced with value list |
-| Endor,Naboo,Dagobah |Comma separated value list |
-
-## Example 03: Going crazy
-
-```
-  %concept
-    %names command
-    %tags computing,directive,computer,perform,specific,task
-    %def In computing, is a directive to a computer program to perform a specific task.
-    %table{:action, :description}
-      %template{:NAME => 'Endor,Naboo,Dabobah'}
-        %row
-          %col mkdir NAME
-          %col Create NAME directory
-        %row
-          %col rmdir NAME
-          %col Delete NAME directory
-        %row
-          %col touch NAME
-          %col Create NAME file
-        %row
-          %col rm NAME
-          %col Delete NAME file
-        %row
-          %col useradd NAME
-          %col Create user NAME
-        %row
-          %col userdel NAME
-          %col Delete user NAME
-```

data/docs/install/README.md

@@ -1,38 +0,0 @@
-
-[<< back](../../README.md)
-
-# Installation
-
-* **Install** Asker:
-    1. Install Ruby on your system.
-    2. `gem install asker-tool`
-
-Run `asker version` to check that your installation is ok.
-
-> **FIND asker COMMAND**: If you have problems to find `asker`command (OpenSUSE distro), try this:
-> * `find / -name asker`, to find absolute path to teuton command.
-> * As superuser do `ln -s /PATH/TO/bin/asker /usr/local/bin/asker`, to create symbolic link to asker command.
-
-* **Update** Asker with `gem asker-tool update`.
-* **Uninstall** Asker with `gem uninstall asker-tool`
-
-> Others ways to install Asker:
-> * [Installation scripts](scripts.md)
->* [Manual installation](manual.md)
-
----
-# Configuring Asker
-
-There exist `config.ini`file, into Asker base directory with some configurable options.
-
-| Section     | Param    | Default | Values    | Description |
-| ----------- | -------- | ------- | --------- | ----------- |
-| [global]    | internet | no      | yes or no | Accept to connect Google and download find images URLs |
-| [questions] | exclude  |         | Comma separated strings| Exclude questions with this texts into their names |
-
----
-# Download input examples
-
-If you want to download our repository with asker input files:
-
-`git clone https://github.com/dvarrui/asker-inputs.git`