Aire-One
/
LDoc2tl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixed style sheet added

This commit is contained in:
steve donovan 2014-10-26 21:15:29 +02:00
parent c516eebd12
commit d56252b762
2 changed files with 333 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/doc.md
View File

@ -17,9 +17,14 @@ For instance, it is not so married to the idea that Lua modules should be define
Otherwise, the output is very similar, which is no accident since the HTML templates are Otherwise, the output is very similar, which is no accident since the HTML templates are
based directly on LuaDoc. You can ship your own customized templates and style sheets with based directly on LuaDoc. You can ship your own customized templates and style sheets with
your [own project](http://nilnor.github.com/textui/docs/), however. You have an option to your [own project](http://nilnor.github.com/textui/docs/) (also see Graham Hannington's
use Markdown to process the documentation, which means no ugly HTML is needed in doc documentation for [Lua for z/OS](lua4z.com/doc/)). LDoc comes with three extra themes; 'pale'
comments. C/C++ extension modules may be documented in a similar way, although function for those who like whitespace, 'one' for one-column output, and 'fixed' for a fixed navigation
bar down the left side.
You have an option to use Markdown to process the documentation, which means no ugly HTML
is needed in doc comments.
C/C++ extension modules may be documented in a similar way, although function
names cannot be inferred from the code itself. names cannot be inferred from the code itself.
LDoc can provide integrated documentation, with traditional function comments, any documents LDoc can provide integrated documentation, with traditional function comments, any documents
@ -1139,7 +1144,7 @@ Another modifier understood by LDoc is `opt`. For instance,
function fun (one,two,three,four) function fun (one,two,three,four)
end end
----> displayed as: fun (one [, two], three [, four]) ----> displayed as: fun (one [, two], three [, four])
A more typical Lua API would have a chain of optional arguments, like so: A more typical Lua API would have a chain of optional arguments, like so:
---- a chain of options ---- a chain of options
@ -1150,7 +1155,7 @@ A more typical Lua API would have a chain of optional arguments, like so:
function fun (one,two,three,four) function fun (one,two,three,four)
end end
----> displayed as: fun (one [, two [, three [, four]]]) ----> displayed as: fun (one [, two [, three [, four]]])
This is a bit tedious to type, so the rule is that a series of 'opt' modifiers will be interpreted This is a bit tedious to type, so the rule is that a series of 'opt' modifiers will be interpreted
as 'opt','optchain'.... . If you want to be explicit, then do `convert_opt=true` in your as 'opt','optchain'.... . If you want to be explicit, then do `convert_opt=true` in your
`config.ld`. `config.ld`.
@ -1245,9 +1250,9 @@ when using Markdown. When explicit will expand non-references in backticks into
- `manual_url` point to an alternative or local location for the Lua manual, e.g. - `manual_url` point to an alternative or local location for the Lua manual, e.g.
'file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html' 'file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html'
- `no_summary` suppress the Contents summary - `no_summary` suppress the Contents summary
- `custom_tags` define some new tags, which will be presented after the function description. - `custom_tags` define some new tags, which will be presented after the function description.
The format is `{<name>,[title=<name>,}{hidden=false,}{format=nil}}`. For instance The format is `{<name>,[title=<name>,}{hidden=false,}{format=nil}}`. For instance
`custom_tags={'remark',title='Remarks'}` will add a little `Remarks` section to the docs for any function `custom_tags={'remark',title='Remarks'}` will add a little `Remarks` section to the docs for any function
containing this tag. `format` can be a function - if not present the default formatter will be used, containing this tag. `format` can be a function - if not present the default formatter will be used,
e.g. Markdown e.g. Markdown
- `custom_see_handler` function that filters see-references - `custom_see_handler` function that filters see-references
@ -1349,12 +1354,14 @@ could call 'minimal Markdown style' where there is no attempt to tag things (exc
emphasizing parameter names). The narrative alone _can_ to be sufficient, if it is written emphasizing parameter names). The narrative alone _can_ to be sufficient, if it is written
well. well.
There are two other stylesheets available in LDoc since 1.4; the first is `ldoc_one.css` which is what There are three other stylesheets available in LDoc since 1.4; the first is `ldoc_one.css` which is what
you get from `one=true` and the second is `ldoc_pale.css`. This is a lighter theme which you get from `one=true` and the second is `ldoc_pale.css`. This is a lighter theme which
might give some relief from the heavier colours of the default. You can use this style with might give some relief from the heavier colours of the default. You can use this style with
`style="!pale"` or `-s !pale`. `style="!pale"` or `-s !pale`.
See the [Lake](http://stevedonovan.github.io/lake/modules/lakelibs.html) documentation See the [Lake](http://stevedonovan.github.io/lake/modules/lakelibs.html) documentation
as an example of its use. as an example of its use. With 1.4.3 there is also the `style='!fixed'` where the
left navigation panel is fixed and does not scroll with the rest of the document;
you may find this assists navigation in complex modules and documents.
Of course, there's no reason why LDoc must always generate HTML. `--ext` defines what output Of course, there's no reason why LDoc must always generate HTML. `--ext` defines what output
extension to use; this can also be set in the configuration file. So it's possible to write extension to use; this can also be set in the configuration file. So it's possible to write

317
ldoc/html/ldoc_fixed_css.lua Normal file
View File

@ -0,0 +1,317 @@
return [[
/* BEGIN RESET
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.com/yui/license.html
version: 2.8.2r1
*/
html {
color: #000;
background: #FFF;
}
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
margin: 0;
padding: 0;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
fieldset,img {
border: 0;
}
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
font-style: inherit;
font-weight: inherit;
}
del,ins {
text-decoration: none;
}
li {
list-style: bullet;
margin-left: 20px;
}
caption,th {
text-align: left;
}
h1,h2,h3,h4,h5,h6 {
font-size: 100%;
font-weight: bold;
}
q:before,q:after {
content: '';
}
abbr,acronym {
border: 0;
font-variant: normal;
}
sup {
vertical-align: baseline;
}
sub {
vertical-align: baseline;
}
legend {
color: #000;
}
input,button,textarea,select,optgroup,option {
font-family: inherit;
font-size: inherit;
font-style: inherit;
font-weight: inherit;
}
input,button,textarea,select {*font-size:100%;
}
/* END RESET */
body {
margin-left: 1em;
margin-right: 1em;
font-family: arial, helvetica, geneva, sans-serif;
background-color: #ffffff; margin: 0px;
}
code, tt { font-family: monospace; }
span.parameter { font-family:monospace; }
span.parameter:after { content:":"; }
span.types:before { content:"("; }
span.types:after { content:")"; }
.type { font-weight: bold; font-style:italic }
body, p, td, th { font-size: .95em; line-height: 1.2em;}
p, ul { margin: 10px 0 0 0px;}
strong { font-weight: bold;}
em { font-style: italic;}
h1 {
font-size: 1.5em;
margin: 0 0 20px 0;
}
h2, h3, h4 { margin: 15px 0 10px 0; }
h2 { font-size: 1.25em; }
h3 { font-size: 1.15em; }
h4 { font-size: 1.06em; }
a:link { font-weight: bold; color: #004080; text-decoration: none; }
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
a:link:hover { text-decoration: underline; }
hr {
color:#cccccc;
background: #00007f;
height: 1px;
}
blockquote { margin-left: 3em; }
ul { list-style-type: disc; }
p.name {
font-family: "Andale Mono", monospace;
padding-top: 1em;
}
pre.example {
background-color: rgb(245, 245, 245);
border: 1px solid silver;
padding: 10px;
margin: 10px 0 10px 0;
font-family: "Andale Mono", monospace;
font-size: .85em;
}
pre {
background-color: rgb(245,245,255); // rgb(245, 245, 245);
border: 1px solid #cccccc; //silver;
padding: 10px;
margin: 10px 0 10px 0;
overflow: auto;
font-family: "Andale Mono", monospace;
}
table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
#container {
margin-left: 1em;
margin-right: 1em;
background-color: #ffffff;
}
#product {
text-align: center;
border-bottom: 1px solid #cccccc;
background-color: #ffffff;
}
#product big {
font-size: 2em;
}
#main {
background-color:#FFFFFF; // #f0f0f0;
border-left: 1px solid #cccccc;
}
#navigation {
position: fixed;
top: 0;
left: 0;
float: left;
width: 14em;
vertical-align: top;
background-color:#FFFFFF; // #f0f0f0;
border-right: 2px solid #cccccc;
overflow: visible;
overflow-y: scroll;
height: 100%;
padding-left: 1em;
}
#navigation h2 {
background-color:#FFFFFF;//:#e7e7e7;
font-size:1.1em;
color:#000000;
text-align: left;
padding:0.2em;
border-bottom:1px solid #dddddd;
}
#navigation ul
{
font-size:1em;
list-style-type: none;
margin: 1px 1px 10px 1px;
}
#navigation li {
text-indent: -1em;
display: block;
margin: 3px 0px 0px 22px;
}
#navigation li li a {
margin: 0px 3px 0px -1em;
}
#content {
margin-left: 14em;
padding: 1em;
padding-left: 2em;
width: 700px;
border-left: 2px solid #cccccc;
// border-right: 2px solid #cccccc;
background-color: #ffffff;
}
#about {
clear: both;
padding-left: 1em;
margin-left: 14em; // avoid the damn sidebar!
border-top: 2px solid #cccccc;
border-left: 2px solid #cccccc;
background-color: #ffffff;
}
@media print {
body {
font: 12pt "Times New Roman", "TimeNR", Times, serif;
}
a { font-weight: bold; color: #004080; text-decoration: underline; }
#main {
background-color: #ffffff;
border-left: 0px;
}
#container {
margin-left: 2%;
margin-right: 2%;
background-color: #ffffff;
}
#content {
padding: 1em;
background-color: #ffffff;
}
#navigation {
display: none;
}
pre.example {
font-family: "Andale Mono", monospace;
font-size: 10pt;
page-break-inside: avoid;
}
}
table.module_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.module_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.module_list td.name { background-color: #f0f0f0; ; min-width: 200px; }
table.module_list td.summary { width: 100%; }
table.function_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.function_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.function_list td.name { background-color: #f6f6ff; ; min-width: 200px; }
table.function_list td.summary { width: 100%; }
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
dl.table h3, dl.function h3 {font-size: .95em;}
ul.nowrap {
overflow:auto;
whitespace:nowrap;
}
/* stop sublists from having initial vertical space */
ul ul { margin-top: 0px; }
ol ul { margin-top: 0px; }
ol ol { margin-top: 0px; }
ul ol { margin-top: 0px; }
/* make the target distinct; helps when we're navigating to a function */
a:target + * {
background-color: #FF9;
}
/* styles for prettification of source */
pre .comment { color: #558817; }
pre .constant { color: #a8660d; }
pre .escape { color: #844631; }
pre .keyword { color: #2239a8; font-weight: bold; }
pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #a8660d; }
pre .number { color: #f8660d; }
pre .operator { color: #2239a8; font-weight: bold; }
pre .preprocessor, pre .prepro { color: #a33243; }
pre .global { color: #800080; }
pre .prompt { color: #558817; }
pre .url { color: #272fc2; text-decoration: underline; }
]]