Re: [Lazarus] FPDoc chms and code examples
On 15/01/2021 7:53 am, Соболь Андрей Евгеньевич via lazarus wrote: > I see that nobody used to a tag for creating documentation lcl, > lazutil. That tag is used only the fpc team. It seem to be a decision made by the Lazarus team. I've used the EXAMPLE tag for years with the tiOPF project as well, and very happy with the result. I only use in for small code snippets though, not full programs. tiOPF docs: https://sourceforge.net/p/tiopf/tiopf_docs/ci/master/tree/ tiOPF HTML doc with example code: http://geldenhuys.co.uk/tiopf/tiobject/ttiobject.dogetfieldbounds.html Regards, Graeme -- fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://fpgui.sourceforge.net/ My public PGP key: http://tinyurl.com/graeme-pgp -- ___ lazarus mailing list lazarus@lists.lazarus-ide.org https://lists.lazarus-ide.org/listinfo/lazarus
[Lazarus] FPDoc chms and code examples - second thread
Oh sorry, I send my message into another thread :( I opened the topic about short code examples that should be embedded in the documentation. About the full examples I know. Also I and Trevor have wrote a readme.txt file for those directories: The file you can read here: https://drive.google.com/file/d/1wHiM-UMClcjvmBLj1PQDwwQ4sNKdXl79/view?usp=sharing > Me personally prefer to place short code snippets into help pages, with > some syntax highlight. Also, big code samples can be made as separate help > (html) files, with detailed description. Same as in Wiki. > > Pure code examples can be found in lazarus/examples directory, they even > have browser, embedded in IDE (create project, browse samples). > > On Fri, Jan 15, 2021, 10:53 Andrey Sobol via lazarus < > lazarus@lists.lazarus-ide.org> wrote: > >> Hello, >> I see that nobody used to a tag for creating documentation lcl, >> lazutil. That tag is used only the fpc team. >> I have read a documentation and saw rtl .xml`s and so. >> I want to create a directory for used examples of code as : >> >> - lazarus/doc/exlcl >> - lazarus/doc/exlazutil >> >> and put inside files in notation with dots. For example: >> fileutil.findallfiles.pas (I think it will be convenient) >> >> + readme.txt (into those directories) >> + wiki descriptions about it. >> >> I have checked it, a html`s works and a chm`s too. >> >> What is yours opinion about it? >> And how to create directory, also by patch? >> >> Andrey Sobol.-- Andrey -- Andrey -- ___ lazarus mailing list lazarus@lists.lazarus-ide.org https://lists.lazarus-ide.org/listinfo/lazarus
Re: [Lazarus] FPDoc chms and code examples
I opened the topic about short code examples that should be embedded in the documentation. About the full examples I know. Also I and Trevor have wrote a readme.txt file for those directories: The file you can read here: https://drive.google.com/file/d/1wHiM-UMClcjvmBLj1PQDwwQ4sNKdXl79/view?usp=sharing Me personally prefer to place short code snippets into help pages, with some syntax highlight. Also, big code samples can be made as separate help (html) files, with detailed description. Same as in Wiki. Pure code examples can be found in lazarus/examples directory, they even have browser, embedded in IDE (create project, browse samples). On Fri, Jan 15, 2021, 10:53 Andrey Sobol via lazarus < lazarus@lists.lazarus-ide.org> wrote: Hello, I see that nobody used to a tag for creating documentation lcl, lazutil. That tag is used only the fpc team. I have read a documentation and saw rtl .xml`s and so. I want to create a directory for used examples of code as : - lazarus/doc/exlcl - lazarus/doc/exlazutil and put inside files in notation with dots. For example: fileutil.findallfiles.pas (I think it will be convenient) + readme.txt (into those directories) + wiki descriptions about it. I have checked it, a html`s works and a chm`s too. What is yours opinion about it? And how to create directory, also by patch? Andrey Sobol.-- Andrey -- ___ lazarus mailing list lazarus@lists.lazarus-ide.org https://lists.lazarus-ide.org/listinfo/lazarus
Re: [Lazarus] FPDoc chms and code examples
Me personally prefer to place short code snippets into help pages, with some syntax highlight. Also, big code samples can be made as separate help (html) files, with detailed description. Same as in Wiki. Pure code examples can be found in lazarus/examples directory, they even have browser, embedded in IDE (create progect, browse samples). On Fri, Jan 15, 2021, 10:53 Соболь Андрей Евгеньевич via lazarus < lazarus@lists.lazarus-ide.org> wrote: > Hello, > I see that nobody used to a tag for creating documentation lcl, > lazutil. That tag is used only the fpc team. > I have read a documentation and saw rtl .xml`s and so. > I want to create a directory for used examples of code as : > > - lazarus/doc/exlcl > - lazarus/doc/exlazutil > > and put inside files in notation with dots. For example: > fileutil.findallfiles.pas (I think it will be convenient) > > + readme.txt (into those directories) > + wiki descriptions about it. > > I have checked it, a html`s works and a chm`s too. > > What is yours opinion about it? > And how to create directory, also by patch? > > Andrey Sobol. > > > -- > Это сообщение было проверено AVG на наличие вирусов. > http://www.avg.com > > -- > ___ > lazarus mailing list > lazarus@lists.lazarus-ide.org > https://lists.lazarus-ide.org/listinfo/lazarus > -- ___ lazarus mailing list lazarus@lists.lazarus-ide.org https://lists.lazarus-ide.org/listinfo/lazarus
[Lazarus] FPDoc chms and code examples
Hello, I see that nobody used to a tag for creating documentation lcl, lazutil. That tag is used only the fpc team. I have read a documentation and saw rtl .xml`s and so. I want to create a directory for used examples of code as : - lazarus/doc/exlcl - lazarus/doc/exlazutil and put inside files in notation with dots. For example: fileutil.findallfiles.pas (I think it will be convenient) + readme.txt (into those directories) + wiki descriptions about it. I have checked it, a html`s works and a chm`s too. What is yours opinion about it? And how to create directory, also by patch? Andrey Sobol. -- Это сообщение было проверено AVG на наличие вирусов. http://www.avg.com -- ___ lazarus mailing list lazarus@lists.lazarus-ide.org https://lists.lazarus-ide.org/listinfo/lazarus
