This repository has been archived by the owner on Nov 20, 2020. It is now read-only.
/
readme.txt
93 lines (57 loc) · 2.35 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
---------------------------------------------------------------
Module: AskLua
Purpose: to add interactive help to other modules
Author: Julio Manuel Fernandez-Diaz
Profesor Titular, Department of Physics
University of Oviedo (Spain)
Date: February 2010
Version: 0.1
License: Public domain
---------------------------------------------------------------
Introduction
------------
AskLua implements a help integrated system for on line use in the
interactive interpreter, and for generating documentation in "html"
and printed formats.
AskLua provides a unique module, "ask", which is little intrusive and,
although it occupies some memory, it can be deleted by the user at any
time if he/she does not want to continue with the help on line.
The system is fairly integrated, in such a way that it is possible to
easily add help for an existing module, even of binary type.
Files provided
--------------
readme.txt -- this file
license.txt -- license information
doc/asklua.pdf -- descriptive document (in English) about `asklua`
doc/asklua_spanish.pdf -- documento descriptivo (en español) sobre `asklua`
ask.lua -- the module
doc/ask.html -- "html" file created by
lua -e "require'ask'; ask.doc''"
doc/ask.pdf -- the same converted to PDF
doc/default.css -- style sheet used in the "html" generation
example/mininum.lua -- a numerical sample module to accompany "ask"
example/mininum.html -- "html" file created by
lua -e "require'mininum'; ask.doc''"
example/mininum.pdf -- the same converted to PDF
example/mininum_test.lua -- lua file for testing "mininum"
Installing
----------
* From tar.gz and zip formats:
unpack it and move "ask.lua" to a convenient path.
* From luarocks:
luarocks install asklua
Using it
--------
$ lua
> require "ask"
From this point we have help for the module "ask".
If other module with help, v.g., "mininum" that accompanies "ask",
is loaded:
> require "mininum"
From this point we have help for "mininum", v.g.:
> ask"^l"
list the functions in "mininum", and:
> ask"root^u"
shows the usage help for function "root" in "mininum".
To generate all the documentation about "mininum" in "html" format:
$ lua -e "require'mininum'; ask.doc''"