mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-19 00:39:26 +02:00
Docs: RttiControls. Adds project file, css, and script needed to produce help formats.
(cherry picked from commit e6f66a8da3)
This commit is contained in:
dsiders
Maxim Ganetsky
parent
83330f6e0a
commit
f7f43c1274
24
components/rtticontrols/fpdoc/make-docs.sh
Normal file
24
components/rtticontrols/fpdoc/make-docs.sh
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# SET THE CORRECT PATHS FOR YOUR SYSTEM
|
||||||
|
# path to Lazarus docs directory
|
||||||
|
docdir="../../../docs"
|
||||||
|
|
||||||
|
# path to fpdoc executable
|
||||||
|
#fpcdir="../../../fpc/3.2.2/bin/x86_64-win64"
|
||||||
|
fpcdir="../../../../fpc331/fpc/bin/x86_64-win64"
|
||||||
|
|
||||||
|
echo "RTTIControls package"
|
||||||
|
|
||||||
|
# generate chm format without footers
|
||||||
|
# imports done manually to set the correct prefix for the output format
|
||||||
|
# output to current directory
|
||||||
|
$fpcdir/fpdoc.exe --project=rtticontrols-project.xml --format=chm --import="$docdir/chm/rtl.xct,ms-its:rtl.chm::/" --import="$docdir/chm/fcl.xct,ms-its:fcl.chm::/" --import="$docdir/chm/lcl.xct,ms-its:lcl.chm::/" --import="$docdir/chm/lazutils.xct,ms-its:lazutils.chm::/"
|
||||||
|
|
||||||
|
# copy generated chm help to lazarus docs directory
|
||||||
|
cp -v rtticontrols.{chm,xct} $docdir/chm/
|
||||||
|
|
||||||
|
# generate html format without footers
|
||||||
|
# imports done manually to set the correct prefix for the output format
|
||||||
|
# html written to rtticontrols sub-directory
|
||||||
|
$fpcdir/fpdoc.exe --project=rtticontrols-project.xml --format=html --import="$docdir/chm/rtl.xct,../rtl/" --import="$docdir/chm/fcl.xct,../fcl/" --import="$docdir/chm/lcl.xct,../lcl/" --import="$docdir/chm/lazutils.xct,../lazutils/" --output=rtticontrols
|
||||||
48
components/rtticontrols/fpdoc/rtticontrols-project.xml
Normal file
48
components/rtticontrols/fpdoc/rtticontrols-project.xml
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<docproject>
|
||||||
|
<options>
|
||||||
|
<option name="ostarget" value="Win64"/>
|
||||||
|
<option name="cputarget" value="x86_64"/>
|
||||||
|
<option name="hide-protected" value="false"/>
|
||||||
|
<option name="show-private" value="false"/>
|
||||||
|
<option name="warn-no-node" value="false"/>
|
||||||
|
<option name="stop-on-parser-error" value="false"/>
|
||||||
|
<option name="parse-impl" value="false"/>
|
||||||
|
<option name="dont-trim" value="true"/>
|
||||||
|
<option name="emit-notes" value="false"/>
|
||||||
|
<option name="auto-index" value="true"/>
|
||||||
|
<option name="auto-toc" value="true"/>
|
||||||
|
<option name="css-file" value="rtticontrols.css"/>
|
||||||
|
<option name="chm-title" value="(RttiControls) RTTI Controls Package"/>
|
||||||
|
<!-- <option name="footer" value="rtticontrols-footer.xml"/> -->
|
||||||
|
<!-- <option name="format" value="CHM"/> -->
|
||||||
|
</options>
|
||||||
|
<packages>
|
||||||
|
<package name="runtimetypeinfocontrols" output="rtticontrols" content="rtticontrols.xct">
|
||||||
|
<units>
|
||||||
|
<unit file="../rttictrls.pas"/>
|
||||||
|
<unit file="../rttigrids.pas"/>
|
||||||
|
</units>
|
||||||
|
<descriptions>
|
||||||
|
<description file="rttictrls.xml"/>
|
||||||
|
<description file="rttigrids.xml"/>
|
||||||
|
</descriptions>
|
||||||
|
<imports>
|
||||||
|
<!-- pass imports as command line arguments... prefixes differ for chm and html -->
|
||||||
|
<!--
|
||||||
|
For CHM:
|
||||||
|
<import file="../../../docs/chm/rtl.xct" prefix="ms-its:rtl.chm::/"/>
|
||||||
|
<import file="../../../docs/chm/fcl.xct" prefix="ms-its:fcl.chm::/"/>
|
||||||
|
<import file="../../../docs/chm/lcl.xct" prefix="ms-its:lcl.chm::/"/>
|
||||||
|
<import file="../../../docs/chm/lazutils.xct" prefix="ms-its:lazutils.chm::/"/>
|
||||||
|
|
||||||
|
For HTML:
|
||||||
|
<import file="../../../docs/chm/rtl.xct" prefix="../rtl/"/>
|
||||||
|
<import file="../../../docs/chm/fcl.xct" prefix="../fcl/"/>
|
||||||
|
<import file="../../../docs/chm/lcl.xct" prefix="../lcl/"/>
|
||||||
|
<import file="../../../docs/chm/lazutils.xct" prefix="../lazutils/"/>
|
||||||
|
-->
|
||||||
|
</imports>
|
||||||
|
</package>
|
||||||
|
</packages>
|
||||||
|
</docproject>
|
||||||
204
components/rtticontrols/fpdoc/rtticontrols.css
Normal file
204
components/rtticontrols/fpdoc/rtticontrols.css
Normal file
@ -0,0 +1,204 @@
|
|||||||
|
/*
|
||||||
|
fpdoc.css
|
||||||
|
Modified for use with Lazarus LCL and LazUtils documentation
|
||||||
|
*/
|
||||||
|
|
||||||
|
body {
|
||||||
|
background: white;
|
||||||
|
color: black;
|
||||||
|
font-size: 12pt;
|
||||||
|
font-family: "San Francisco", "Roboto", "Noto Sans", "Open Sans", "Segoe UI", "Helvetica", "Arial", sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
p, th, td, caption, h1, h2, h3, ul, ol, dl {
|
||||||
|
font-family: "San Francisco", "Roboto", "Noto Sans", "Open Sans", "Segoe UI", "Helvetica", "Arial", sans-serif;
|
||||||
|
color: black;
|
||||||
|
}
|
||||||
|
|
||||||
|
tt, span.kw, pre {
|
||||||
|
font-family: "Menlo", "JetBrains Mono", "Roboto Mono", "Noto Sans Mono", "Inconsolata", "Courier New", Courier, monospace;
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
p, th, td, caption, ul, ol, dl, tt, span.kw, pre {
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
A:link {
|
||||||
|
color: blue;
|
||||||
|
}
|
||||||
|
|
||||||
|
A:visited {
|
||||||
|
color: darkblue;
|
||||||
|
}
|
||||||
|
|
||||||
|
A:active {
|
||||||
|
color: red;
|
||||||
|
}
|
||||||
|
|
||||||
|
A {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
A:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, td.h2 {
|
||||||
|
color: #005A9C;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Especially for Netscape on Linux: */
|
||||||
|
h3, td.h3 {
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* source fragments */
|
||||||
|
span.code {
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* symbols in source fragments */
|
||||||
|
span.sym {
|
||||||
|
color: darkred;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* keywords in source fragments */
|
||||||
|
span.kw {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* comments in source fragments */
|
||||||
|
span.cmt {
|
||||||
|
color: darkcyan;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* directives in source fragments */
|
||||||
|
span.dir {
|
||||||
|
color: OrangeRed;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* numbers in source fragments */
|
||||||
|
span.num {
|
||||||
|
color: darkmagenta;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* characters (#...) in source fragments */
|
||||||
|
span.chr {
|
||||||
|
color: darkcyan;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* strings in source fragments */
|
||||||
|
span.str {
|
||||||
|
color: blue;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* assembler passages in source fragments */
|
||||||
|
span.asm {
|
||||||
|
color: green;
|
||||||
|
}
|
||||||
|
|
||||||
|
td {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
|
||||||
|
td.pre {
|
||||||
|
white-space: pre;
|
||||||
|
}
|
||||||
|
|
||||||
|
table caption {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.cmt {
|
||||||
|
color: gray;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.warning {
|
||||||
|
color: red;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* !!!: How should we define this...? */
|
||||||
|
span.file {
|
||||||
|
color: darkgreen;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.remark {
|
||||||
|
background-color: #ffffc0;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.bar {
|
||||||
|
background-color: #a0c0ff;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.footer {
|
||||||
|
margin-top: .5em;
|
||||||
|
width: 100%;
|
||||||
|
font-size: .875em;
|
||||||
|
/* font-style: italic; */
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.bartitle {
|
||||||
|
font-weight: bold;
|
||||||
|
font-style: normal;
|
||||||
|
color: darkblue;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.footer {
|
||||||
|
font-style: italic;
|
||||||
|
color: darkblue;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* definition list */
|
||||||
|
dl {
|
||||||
|
/* border: 2px solid #ccc; */
|
||||||
|
display: block;
|
||||||
|
margin: 1em 0 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* definition list: term */
|
||||||
|
dt {
|
||||||
|
/*
|
||||||
|
float: left;
|
||||||
|
clear: left;
|
||||||
|
*/
|
||||||
|
width: auto; /* normally browsers default width of largest item */
|
||||||
|
/* padding-right: 1.25em; */
|
||||||
|
font-weight: bold;
|
||||||
|
color: darkgreen;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* definition list: description */
|
||||||
|
dd {
|
||||||
|
margin: 0 0 0 2em;
|
||||||
|
padding: 0 0 0.5em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* for browsers in standards compliance mode */
|
||||||
|
td p { margin: 0; }
|
||||||
|
|
||||||
|
var { font-weight: bold; }
|
||||||
|
|
||||||
|
span.toggletreeclose {
|
||||||
|
background: url(minus.png) center left no-repeat;
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.toggletreeopen {
|
||||||
|
background: url(plus.png) center left no-repeat;
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
li.classtree ul { display: block; }
|
||||||
|
ul.classtreelist { list-style-type:none; }
|
||||||
|
ul.classtreelist li { padding-left: 0px; }
|
||||||
|
li.classtreeclosed ul { display: none; }
|
||||||
|
|
||||||
|
hr.footer-sep { margin-top: .667em; }
|
||||||
|
td.footer-doc { width: 36%; text-align: left; font-weight: bold; color: Black; }
|
||||||
|
td.footer-ver { width: 32%; text-align: center; color: Gray; }
|
||||||
|
td.footer-date { width: 32%; text-align: right; color: Gray; }
|
||||||
Loading…
Reference in New Issue
Block a user