mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-14 10:59:11 +02:00
removed obsolete example for fpdoc help
git-svn-id: trunk@21326 -
This commit is contained in:
mattias
parent
d34808cb66
commit
d0b3079bd2
9
.gitattributes
vendored
9
.gitattributes
vendored
@ -2480,15 +2480,6 @@ examples/groupboxnested.pas svneol=native#text/pascal
|
|||||||
examples/hello.lpi svneol=native#text/plain
|
examples/hello.lpi svneol=native#text/plain
|
||||||
examples/hello.pp svneol=native#text/pascal
|
examples/hello.pp svneol=native#text/pascal
|
||||||
examples/helloform.pp svneol=native#text/pascal
|
examples/helloform.pp svneol=native#text/pascal
|
||||||
examples/helpforpackage/README.txt svneol=native#text/plain
|
|
||||||
examples/helpforpackage/demopackagewithhelp.lpk svneol=native#text/plain
|
|
||||||
examples/helpforpackage/demopackagewithhelp.pas svneol=native#text/plain
|
|
||||||
examples/helpforpackage/html/index.html svneol=native#text/plain
|
|
||||||
examples/helpforpackage/html/pkghelpdemounit1/index-5.html svneol=native#text/plain
|
|
||||||
examples/helpforpackage/html/pkghelpdemounit1/index.html svneol=native#text/plain
|
|
||||||
examples/helpforpackage/html/pkghelpdemounit1/register.html svneol=native#text/plain
|
|
||||||
examples/helpforpackage/pkghelpdemounit1.pas svneol=native#text/plain
|
|
||||||
examples/helpforpackage/xml/pkghelpdemounit1.xml svneol=native#text/plain
|
|
||||||
examples/helphtml/html/edit1.html svneol=native#text/plain
|
examples/helphtml/html/edit1.html svneol=native#text/plain
|
||||||
examples/helphtml/html/edit2.html svneol=native#text/plain
|
examples/helphtml/html/edit2.html svneol=native#text/plain
|
||||||
examples/helphtml/html/index.html svneol=native#text/plain
|
examples/helphtml/html/index.html svneol=native#text/plain
|
||||||
|
|||||||
10
.gitignore
vendored
10
.gitignore
vendored
@ -251,16 +251,6 @@ examples/gridexamples/grid_semaphor/example/units
|
|||||||
examples/gridexamples/grid_semaphor/units
|
examples/gridexamples/grid_semaphor/units
|
||||||
examples/gridexamples/gridcelleditor/*.bak
|
examples/gridexamples/gridcelleditor/*.bak
|
||||||
examples/gridexamples/gridcelleditor/units
|
examples/gridexamples/gridcelleditor/units
|
||||||
examples/help/*.bak
|
|
||||||
examples/help/units
|
|
||||||
examples/helpforpackage/*.bak
|
|
||||||
examples/helpforpackage/html/*.bak
|
|
||||||
examples/helpforpackage/html/pkghelpdemounit1/*.bak
|
|
||||||
examples/helpforpackage/html/pkghelpdemounit1/units
|
|
||||||
examples/helpforpackage/html/units
|
|
||||||
examples/helpforpackage/units
|
|
||||||
examples/helpforpackage/xml/*.bak
|
|
||||||
examples/helpforpackage/xml/units
|
|
||||||
examples/helphtml/*.bak
|
examples/helphtml/*.bak
|
||||||
examples/helphtml/html/*.bak
|
examples/helphtml/html/*.bak
|
||||||
examples/helphtml/html/units
|
examples/helphtml/html/units
|
||||||
|
|||||||
@ -1,16 +0,0 @@
|
|||||||
This package (demopackagewithhelp.lpk) demonstrates how to register help in the
|
|
||||||
IDE for the sources of a package.
|
|
||||||
|
|
||||||
The help itself is in fpdoc format.
|
|
||||||
Here is an example how to create the basic fpdoc xml file from the source:
|
|
||||||
|
|
||||||
makeskel --package=demopackagewithhelp --input=pkghelpdemounit1.pas --output=xml/pkghelpdemounit1.xml
|
|
||||||
|
|
||||||
Use the program LazDE (lazarus/doceditor/lazde.lpi)
|
|
||||||
or LazDoc tool in the IDE to write some documentation.
|
|
||||||
|
|
||||||
Then create the html files from the xml files:
|
|
||||||
|
|
||||||
cd html && fpdoc --package=demopackagewithhelp --descr=../xml/pkghelpdemounit1.xml --input=../pkghelpdemounit1.pas
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<CONFIG>
|
|
||||||
<Package Version="2">
|
|
||||||
<Name Value="DemoPackageWithHelp"/>
|
|
||||||
<CompilerOptions>
|
|
||||||
<Version Value="5"/>
|
|
||||||
<SearchPaths>
|
|
||||||
<UnitOutputDirectory Value="lib/$(TargetCPU)-$(TargetOS)"/>
|
|
||||||
</SearchPaths>
|
|
||||||
<CodeGeneration>
|
|
||||||
<Generate Value="Faster"/>
|
|
||||||
</CodeGeneration>
|
|
||||||
<Other>
|
|
||||||
<CompilerPath Value="$(CompPath)"/>
|
|
||||||
</Other>
|
|
||||||
</CompilerOptions>
|
|
||||||
<Files Count="1">
|
|
||||||
<Item1>
|
|
||||||
<Filename Value="pkghelpdemounit1.pas"/>
|
|
||||||
<HasRegisterProc Value="True"/>
|
|
||||||
<UnitName Value="PkgHelpDemoUnit1"/>
|
|
||||||
</Item1>
|
|
||||||
</Files>
|
|
||||||
<Type Value="RunAndDesignTime"/>
|
|
||||||
<RequiredPkgs Count="2">
|
|
||||||
<Item1>
|
|
||||||
<PackageName Value="IDEIntf"/>
|
|
||||||
</Item1>
|
|
||||||
<Item2>
|
|
||||||
<PackageName Value="FCL"/>
|
|
||||||
<MinVersion Major="1" Valid="True"/>
|
|
||||||
</Item2>
|
|
||||||
</RequiredPkgs>
|
|
||||||
<UsageOptions>
|
|
||||||
<UnitPath Value="$(PkgOutDir)"/>
|
|
||||||
</UsageOptions>
|
|
||||||
<PublishOptions>
|
|
||||||
<Version Value="2"/>
|
|
||||||
<IgnoreBinaries Value="False"/>
|
|
||||||
</PublishOptions>
|
|
||||||
</Package>
|
|
||||||
</CONFIG>
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
{ This file was automatically created by Lazarus. Do not edit!
|
|
||||||
This source is only used to compile and install the package.
|
|
||||||
}
|
|
||||||
|
|
||||||
unit DemoPackageWithHelp;
|
|
||||||
|
|
||||||
interface
|
|
||||||
|
|
||||||
uses
|
|
||||||
PkgHelpDemoUnit1, LazarusPackageIntf;
|
|
||||||
|
|
||||||
implementation
|
|
||||||
|
|
||||||
procedure Register;
|
|
||||||
begin
|
|
||||||
RegisterUnit('PkgHelpDemoUnit1', @PkgHelpDemoUnit1.Register);
|
|
||||||
end;
|
|
||||||
|
|
||||||
initialization
|
|
||||||
RegisterPackage('DemoPackageWithHelp', @Register);
|
|
||||||
end.
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<title>Reference for package 'demopackagewithhelp'</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="fpdoc.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<table cellpadding="4" cellspacing="0" border="0" width="100%" class="bar">
|
|
||||||
<tr>
|
|
||||||
<td><b></b></td>
|
|
||||||
<td align="right"><span class="bartitle"> (<a href="index.html">#demopackagewithhelp</a>)</span></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h1>Reference for package 'demopackagewithhelp'</h1>
|
|
||||||
<p></p>
|
|
||||||
<h2>Units</h2>
|
|
||||||
<table cellspacing="0" cellpadding="0">
|
|
||||||
<tr>
|
|
||||||
<td valign="top"><p><tt><span class="code"><a href="pkghelpdemounit1/index.html">PkgHelpDemoUnit1</a></span></tt></p></td>
|
|
||||||
<td><p> </p></td>
|
|
||||||
<td><p class="cmt"></p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<title>Reference for unit 'PkgHelpDemoUnit1': Procedures and functions</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../fpdoc.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<table cellpadding="4" cellspacing="0" border="0" width="100%" class="bar">
|
|
||||||
<tr>
|
|
||||||
<td><b>[<a href="../pkghelpdemounit1/index.html">Overview</a>][Procedures and functions]</b></td>
|
|
||||||
<td align="right"><span class="bartitle">Reference for unit 'PkgHelpDemoUnit1' (<a href="../index.html">#demopackagewithhelp</a>)</span></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h1>Reference for unit 'PkgHelpDemoUnit1': Procedures and functions</h1>
|
|
||||||
<table cellspacing="0" cellpadding="0">
|
|
||||||
<tr>
|
|
||||||
<td valign="top"><p><tt><span class="code"><a href="../pkghelpdemounit1/register.html">Register</a></span></tt></p></td>
|
|
||||||
<td><p> </p></td>
|
|
||||||
<td><p class="cmt"></p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<title>Reference for unit 'PkgHelpDemoUnit1'</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../fpdoc.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<table cellpadding="4" cellspacing="0" border="0" width="100%" class="bar">
|
|
||||||
<tr>
|
|
||||||
<td><b>[Overview][<a href="../pkghelpdemounit1/index-5.html">Procedures and functions</a>]</b></td>
|
|
||||||
<td align="right"><span class="bartitle">Reference for unit 'PkgHelpDemoUnit1' (<a href="../index.html">#demopackagewithhelp</a>)</span></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h1>Reference for unit 'PkgHelpDemoUnit1'</h1>
|
|
||||||
<p></p>
|
|
||||||
<table cellspacing="0" cellpadding="0">
|
|
||||||
<tr>
|
|
||||||
<td><p><tt><span class="code"><span class="kw">uses</span></span></tt></p></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td valign="top"><p><tt><span class="code"> Classes<span class="sym">,</span> </span></tt></p></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td valign="top"><p><tt><span class="code"> SysUtils<span class="sym">,</span> </span></tt></p></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td valign="top"><p><tt><span class="code"> HelpFPDoc<span class="sym">;</span> </span></tt></p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<title>Register</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../fpdoc.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<table cellpadding="4" cellspacing="0" border="0" width="100%" class="bar">
|
|
||||||
<tr>
|
|
||||||
<td><b>[<a href="../pkghelpdemounit1/index.html">Overview</a>][<a href="../pkghelpdemounit1/index-5.html">Procedures and functions</a>]</b></td>
|
|
||||||
<td align="right"><span class="bartitle">Reference for unit 'PkgHelpDemoUnit1' (<a href="../index.html">#demopackagewithhelp</a>)</span></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h1>Register</h1>
|
|
||||||
<p></p>
|
|
||||||
<h2>Declaration</h2>
|
|
||||||
<p>Source position: pkghelpdemounit1.pas line 28</p>
|
|
||||||
<table cellspacing="0" cellpadding="0">
|
|
||||||
<tr>
|
|
||||||
<td><p><tt><span class="code"><span class="kw">procedure</span> Register<span class="sym">;</span></span></tt></p></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,39 +0,0 @@
|
|||||||
{
|
|
||||||
*****************************************************************************
|
|
||||||
* *
|
|
||||||
* See the file COPYING.modifiedLGPL.txt, included in this distribution, *
|
|
||||||
* for details about the copyright. *
|
|
||||||
* *
|
|
||||||
* This program is distributed in the hope that it will be useful, *
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
|
|
||||||
* *
|
|
||||||
*****************************************************************************
|
|
||||||
|
|
||||||
Author: Mattias Gaertner
|
|
||||||
|
|
||||||
Abstract:
|
|
||||||
Example unit demonstrating how to register IDE online help for the sources
|
|
||||||
of a package.
|
|
||||||
}
|
|
||||||
unit PkgHelpDemoUnit1;
|
|
||||||
|
|
||||||
{$mode objfpc}{$H+}
|
|
||||||
|
|
||||||
interface
|
|
||||||
|
|
||||||
uses
|
|
||||||
Classes, SysUtils, HelpFPDoc;
|
|
||||||
|
|
||||||
procedure Register;
|
|
||||||
|
|
||||||
implementation
|
|
||||||
|
|
||||||
procedure Register;
|
|
||||||
begin
|
|
||||||
RegisterFPDocHTMLHelpForPackage('Demo Help DB','Demo Help Database',
|
|
||||||
'file://$PkgDir(DemoPackageWithHelp)/html','DemoPackageWithHelp');
|
|
||||||
end;
|
|
||||||
|
|
||||||
end.
|
|
||||||
|
|
||||||
@ -1,57 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
||||||
<fpdoc-descriptions>
|
|
||||||
<package name="demopackagewithhelp">
|
|
||||||
|
|
||||||
<!--
|
|
||||||
====================================================================
|
|
||||||
PkgHelpDemoUnit1
|
|
||||||
====================================================================
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="PkgHelpDemoUnit1">
|
|
||||||
<short></short>
|
|
||||||
<descr>
|
|
||||||
</descr>
|
|
||||||
|
|
||||||
<!-- unresolved type reference Visibility: default -->
|
|
||||||
<element name="Classes">
|
|
||||||
<short></short>
|
|
||||||
<descr>
|
|
||||||
</descr>
|
|
||||||
<seealso>
|
|
||||||
</seealso>
|
|
||||||
</element>
|
|
||||||
|
|
||||||
<!-- unresolved type reference Visibility: default -->
|
|
||||||
<element name="SysUtils">
|
|
||||||
<short></short>
|
|
||||||
<descr>
|
|
||||||
</descr>
|
|
||||||
<seealso>
|
|
||||||
</seealso>
|
|
||||||
</element>
|
|
||||||
|
|
||||||
<!-- unresolved type reference Visibility: default -->
|
|
||||||
<element name="HelpFPDoc">
|
|
||||||
<short></short>
|
|
||||||
<descr>
|
|
||||||
</descr>
|
|
||||||
<seealso>
|
|
||||||
</seealso>
|
|
||||||
</element>
|
|
||||||
|
|
||||||
<!-- procedure Visibility: default -->
|
|
||||||
<element name="Register">
|
|
||||||
<short></short>
|
|
||||||
<descr>
|
|
||||||
</descr>
|
|
||||||
<errors>
|
|
||||||
</errors>
|
|
||||||
<seealso>
|
|
||||||
</seealso>
|
|
||||||
</element>
|
|
||||||
|
|
||||||
</module> <!-- PkgHelpDemoUnit1 -->
|
|
||||||
|
|
||||||
</package>
|
|
||||||
</fpdoc-descriptions>
|
|
||||||
Loading…
Reference in New Issue
Block a user