summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Gesang <pgesang@ix.urz.uni-heidelberg.de>2012-02-23 01:48:29 +0100
committerPhilipp Gesang <pgesang@ix.urz.uni-heidelberg.de>2012-02-23 01:48:29 +0100
commit32a30893ac3d6a96642af57c3c24f0aeeed1536a (patch)
tree2ec4df51958156e8c8a3a25b4d82626daabed459
parent53f2382ebb2ac9ddf29f9fcb7baa0f52f2574a07 (diff)
downloadenigma-32a30893ac3d6a96642af57c3c24f0aeeed1536a.tar.gz
[ichd] doc fixes
-rw-r--r--tex/context/third/enigma/enigma.lua54
1 files changed, 27 insertions, 27 deletions
diff --git a/tex/context/third/enigma/enigma.lua b/tex/context/third/enigma/enigma.lua
index cffbb2c..7eec8bc 100644
--- a/tex/context/third/enigma/enigma.lua
+++ b/tex/context/third/enigma/enigma.lua
@@ -24,7 +24,7 @@ Exported functionality will be collected in the table
local enigma = { machines = { }, callbacks = { } }
local format_is_context_p = false
---[[ichd
+--[[ichd--
\startparagraph
Afaict, \LATEX\ for \LUATEX\ still lacks a globally accepted namespacing
convention. This is more than bad, but we’ll have to cope with that. For
@@ -44,7 +44,7 @@ elseif thirddata then -- context
else -- external call, mtx-script or whatever
_G.enigma = enigma
end
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
@@ -95,7 +95,7 @@ local utfcharacters = string.utfcharacters
local glyph_node = nodeid"glyph"
local glue_node = nodeid"glue"
---[[ichd
+--[[ichd--
\startparagraph
The initialization of the module relies heavily on parsers generated by
\type{LPEG}.
@@ -114,7 +114,7 @@ local P, R, S, V, lpegmatch
--local B = lpeg.version() == "0.10" and lpeg.B or nil
---[[ichd
+--[[ichd--
\startparagraph
By default the output to \type{stdout} will be zero. The verbosity level
can be adjusted in order to alleviate debugging.
@@ -123,7 +123,7 @@ can be adjusted in order to alleviate debugging.
local verbose_level = 42
--local verbose_level = 0
---[[ichd
+--[[ichd--
\startparagraph
Historically, Enigma-encoded messages were restricted to a size of 250
characters. With sufficient verbosity we will indicate whether this
@@ -131,7 +131,7 @@ limit has been exceeded during the \TEX\ run.
\stopparagraph
--ichd]]--
local max_msg_length = 250
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
@@ -231,11 +231,11 @@ mnemonic.
end
end
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
---[[ichd
+--[[ichd--
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\startdocsection[title=Pretty printing for debug purposes]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -433,7 +433,7 @@ do
.. pprint_textblock(output)
end
---[[ichd
+--[[ichd--
\startparagraph
Main stdout verbosity wrapper function. Checks if the global verbosity
setting exceeds the specified threshold, and only then pushes the
@@ -450,11 +450,11 @@ end
local new
do
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
---[[ichd
+--[[ichd--
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\startdocsection[title=Rotation]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -501,11 +501,11 @@ has been reached and covers the corner case \emph{double stepping}.
end
machine.rotors = { rc, rb, ra }
end
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
---[[ichd
+--[[ichd--
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\startdocsection[title=Input Preprocessing]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -574,11 +574,11 @@ ten.
["9"] = "neun",
}
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
---[[ichd
+--[[ichd--
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\startdocsection[
title={Main function chain to be applied to single characters},
@@ -624,7 +624,7 @@ substitution is applied.
return result
end
---[[ichd
+--[[ichd--
\startparagraph
Behind the plugboard, every character undergoes seven substitutions: two
for each rotor plus the central one through the reflector. The function
@@ -651,7 +651,7 @@ something goes wrong.
return steps[7]
end
---[[ichd
+--[[ichd--
\startparagraph
Before an input character is passed on to the actual encoding routing,
the function \luafunction{encode_char} matches it agains the latin
@@ -716,7 +716,7 @@ local variable, \identifier{pb_char}.
end
end
---[[ichd
+--[[ichd--
\startparagraph
As the actual encoding proceeds character-wise, the processing of entire
strings needs to be managed externally. This is where
@@ -738,7 +738,7 @@ extraction of successive characters from the sequence.
-- end
-- return tableconcat(result)
--end
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
@@ -841,7 +841,7 @@ extraction of successive characters from the sequence.
}
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
@@ -1044,7 +1044,7 @@ consists of three elements:
return machine
end
end
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
@@ -1105,7 +1105,7 @@ local p_args = P{
}
---[[ichd
+--[[ichd--
\startparagraph
In the next step we process the arguments, check the input for sanity
etc. The function \luafunction{parse_args} will test whether a value has
@@ -1165,11 +1165,11 @@ do
end
end
---[[ichd
+--[[ichd--
\stopdocsection
--ichd]]--
---[[ichd
+--[[ichd--
\startdocsection[title=Callback]
\startparagraph
This is the interface to \TEX. We generate a new callback handler for
@@ -1244,9 +1244,6 @@ enigma.new_machine = function (args, name)
return machine
end --stub
---[[ichd
-\stopdocsection
---ichd]]--
------------------------------------------------------------------------
--local teststring = [[B I IV III 16 26 08 AD CN ET FL GI JV KZ PU QY WX]]
@@ -1258,5 +1255,8 @@ end --stub
--local teststring = [[B I IV III 16 26 08]]
--local teststring = [[B I IV III 01 01 02]]
+--[[ichd--
+\stopdocsection
+--ichd]]--
-- vim:ft=lua:sw=2:ts=2:tw=72