teuton-software / asker Goto Github PK

ASKER generates tons of questions from a definitions input file.

License: GNU General Public License v3.0

Ruby 93.83% HTML 3.70% Shell 0.79% Batchfile 0.01% PowerShell 0.51% Haml 1.07% Dockerfile 0.08%

questions teacher elearning build test gift moodle

asker's Introduction

ASKER

Generate a lot of questions from an input text file with on your own definitions. In a way, this input file is a concept map.

Asker helps trainers to create a huge amount of questions, from a definitions (conceptual entities) input file.

Installation

At first install Ruby and then:

gem install asker-tool

REMEMBER: Update Asker with gem update asker-tool

Usage

Step	Action	Tool	Description
1	Define your concepts	Text plain editor	Create input file with your contents (conceptual map). Here are some examples. And more examples at this repository.
2	Generate questions	`asker PATH/TO/INPUT`	Run `asker` to process input file. Output files are saved into the `output` folder

Let's see an example creating questions from ACDC input example file:

❯ asker docs/examples/bands/acdc.haml

+--------------------+-----------+---------+---------+---+---+----+---+---+----+
| Concept            | Questions | Entries | xFactor | d | b | f  | i | s | t  |
+--------------------+-----------+---------+---------+---+---+----+---+---+----+
| AC/DC              | 46        | 18      | 2.5     | 7 | 0 | 15 | 0 | 4 | 20 |
| Excluded questions | 0         | -       | -       | 0 | 0 | 0  | 0 | 0 | 0  |
+--------------------+-----------+---------+---------+---+---+----+---+---+----+
| 1 concept/s        | 46        | 18      | 2.5     | 7 | 0 | 15 | 0 | 4 | 20 |
+--------------------+-----------+---------+---------+---+---+----+---+---+----+

Features

Free Software License.
Multiplatform.
Input files formats: XML, HAML.
Output formats: GIFT, Moodle XML, YAML.
Question types: true/false, multiple choice, short answer, matching and ordering.
Embeded files: mp3, ogg, wav, jpg, jpeg, png, mp4, ogv and plain text files.

Documentation

Contact

Email: [email protected]

Contributing

Make sure you have Ruby installed
Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request.

asker's People

Contributors

Stargazers

Watchers

Forkers

robertglez mrroot5 teolairlasg amarzar

asker's Issues

asker file --no-output INPUTFILE

The same functionality than "asker file INPUTFILE" but in this case we dont create output files.

QuestionGiftFormatter test

Create test for QuestionGiftFormatter class.

Embeded external textflies into questions

We define our conceptual map using HAML files but often we need to embed external textfiles just to improve our questions... For example like "poems", "programs", "config files", etc....

asker check INPUTFILE

Add functionality that checks (validate syntax) of input file.

Build our HAML file with the conceptual map... may be hard for those that don't like (know) HAML format...and don't like text plain editors...
So it could be usefull to have a GUI front-end to help people build the conceptual map using GUI...then this tool will write and HAML file within data.

ERROR: text too long

Warn user when there are texts too long before upload gift file to Moodle!

La respuesta correcta es: Escribir 10 caractéres que representen un directorio donde el usuario propietario tiene permisos para entrar, crear, renombrar, eliminar ficheros y directorios. Los miembros del grupo propietario tiene permisos para e...(ERROR: text too long)

Bajo número de preguntas de un sólo tipo

Quiero eliminar todos los tipos de preguntas salvo las t8table, el objetivo es generar sólo preguntas en las que los alumnos tengan que rellenar una respuesta corta ¿porqué se obtienen un número bajo de preguntas de este tipo? ¿ de que depende esto ?

El archivo haml solo tiene una pregunta de tipo tabla y estoy usando asker version 2.5.1

%map{ lang: 'es', context: 'Comandos CISCO', version: '1'}
  
  %concept
    %names Comandos para la configuración de un router CISCO
    %tags modo, configuración, nombre, contraseña, consola, IP, máscara, interfaz, puerta, enlace
    %table{fields:'comando, descripción'}
      %row
        %col enable
        %col Entra en el modo privilegiado.
      %row
        %col show ?
        %col Muestra ayuda sobre los comandos disponibles.
      %row
        %col configure terminal
        %col Entra en el modo de configuración.
      %row
        %col hostname
        %col Cambia el nombre del equipo.
      %row
        %col no "comando"
        %col Desactiva un comando.
      %row
        %col logging console
        %col Activa o desactiva los mensajes de consola.
      %row
        %col copy running-config startup-config
        %col Guarda la configuración actual.
      %row
        %col reload
        %col Deshace los cambios hasta la última configuración guardada.
      %row
        %col show running-config
        %col Muestra la configuración actual del dispositivo.
      %row
        %col show ip interface brief
        %col Muestra la configuración de interfaces.
      %row
        %col show ip route
        %col Muestra la tabla de ruteo.
      %row
        %col show ip protocols
        %col Muestra los protocolos de ruteo activos y sus parámetros.
      %row
        %col configure terminal
        %col Entra en el modo de configuración.
      %row
        %col hostname
        %col Cambia el nombre del equipo.
      %row
        %col no logging console
        %col Detiene los mensajes de consola.
      %row
        %col line console 0
        %col Configura la consola.
      %row
        %col logging synchronous
        %col Configura la consola para que no interrumpa instrucciones o respuestas.
      %row
        %col exit
        %col Sube un nivel en la consola.
      %row
        %col end (o CTRL+Z)
        %col Sube al nivel inicial en la consola.
      %row
        %col enable password
        %col Configura la contraseña del modo privilegiado.
      %row
        %col enable secret
        %col Configura la contraseña encriptada del modo privilegiado.

b1match3x1 adds also a misspelled option

Asker generated a question of type b1match3x1 where a wrong option is a misspelled version of a correct one (in my case the word "el" is replaced by "er").
I thought that b1match3x1 didn't add misspelled options, that this was done by b1match3x1misspelled

ES - Entorno gráfico - Roadmap?

SITUACION INICIAL

¡Varios usuarios en algún momento ha preguntado por una aplicación de entorno gráfico para crear los inputs de Asker (mapas de definiciones).

Varias veces lo he empezado, usando distintas tecnologías porque pensaba que el cambio de tecnología me iba a ayudar a terminarlo, pero no. El problema que me encuentro es otro diferente. Cada vez que me pongo con el desarrollo me quedo "atascado" en el mismo punto. El diseño del interfaz gráfico.

PROBLEMA

No consigo encontrar un diseño de interfaz gráfico para Asker que sea más eficaz, eficiente y efectivo que abrir un fichero de texto con un editor (vi, emac, neovim, VCode, Codium, Notepad, Atom , etc) y empezar a escribir.

Por tanto vuelvo a quedarme parado en este punto.

PROPUESTA

@fvarrui me propuso la idea de abrir un debate a la pequeña comunidad Asker, de modo que lo que realmente tengan necesidad de esta nueva funcionalidad tengan la posibilidad de ir aportando sus sugerencias a ver si encontramos camino para desarrollarla.

¡Muchas gracias!

New export format (Moodle) to embed images into guestions.

Add function to export to Moodle export format.
For now only export to gift format. Gift format is used by Moodle of course but Gift format can't embed images.

Moodle format is more complex but can had embeded images... That's nice!,

misspelling in asker.ini

In asker.ini, there are several entries that with a typo in the word "misspelled" (they appear as "mispelled"). I think that in the code something similar happens because for example I was unable to exclude d2true-misspelled questions.

Thank you for such an amazing program!

ruby version

Checking ruby version during installation...

2.3

Filter output questions

This utility will filter the type of questions we want into the output file (Gift format for now).

Misspelled is misspelled :-D

The name of misspelled questions of type "d" miss an "s" (I think that is only with d2-def and d2-name)

d1none-misspelled (good)
d2def-mispelled (wrong)
d2name-mispelled (wrong)
d2false-misspelled (good)

Not a real problem, but just to let you know.

I've installed it over ubuntu 20.04 with
sudo gem install asker-tool
and asker -v says
asker version 2.2.0

Thanks for your time!!

asker check doesn't detect wrong table definition in haml file

The table definition in haml files must not have spaces between %table and {

%table{ :fields => 'Contingut del fitxer' }

but if you insert an space

%table { :fields => 'Contingut del fitxer' }

then asker software generates an error like
Illegal nesting: content can't be both given on the same line as %table and nested within it. (Haml::SyntaxError)
but the check option of Asker says
$>asker check file.haml
Syntax OK!
$>

IA::procesTableXfields

Add this method (IA::processTableXfields) new functionality for work with 1field tables definitions.

Duplicated concepts

Raise a warning when detect duplicated concepts.

Names and tags params are usefull to identify concepts. Posible actions:

Advise or notify warning. Accepting only one definition.
Mix or unify these definitions into one.
Rename automaticaly concepts to avoid duplication.

Propuesta de @amarzar: include_only

Propuesta

Genial ¡¡¡ Han pensado en una opción para el archivo ini que complemente a exclude y que permita seleccionar que se genere un único tipo de pregunta/s, por ejemplo only = t8table o only = t8table, code1

He movido la petición en un issue independiente para facilitar su seguimiento,

Spanish documentations

Translate english documentation to spanish

english documentation

Review and finish the english documentations into ./docs/en