[fpc-pascal] The names of the various FPC documentation
Michael Van Canneyt
michael at freepascal.org
Mon Sep 7 08:59:37 CEST 2009
On Mon, 7 Sep 2009, Graeme Geldenhuys wrote:
> Hi,
>
> Maybe it's just me (please let me know if it is), but looking at the
> various FPC .pdf files in a folder, I am never sure which one I should
> open for whatever I am looking for.
>
> We currently have:
> ref.pdf
> user.pdf
> rtl.pdf
> prog.pdf
> fcl.pdf
> fpdoc.pdf
>
> Out of those 3 seems to have logical names. rtl, fcl and fpdoc. The
> problem I have is the 'user', 'ref' and 'prog' names. Maybe somebody
> can explain to me how I can remember the various information in each of
> these. For example, if I want to know about a Compiler Parameter, or a
> Language syntax, it is never clear which document I should open.
>
> Now seeing that all (half-descent) OSes support long filenames these
> days, couldn't we name them better.
>
> For example:
> ref.pdf is actually about the Object Pascal Language. So why not name
> it Language_Reference_Guide.pdf or Language_Guide.pdf?
>
> prog.pdf is actually about the compiler support options like
> parameters etc... So name this Free_Pascal_Compiler_Guide.pdf
>
> user.pdf is actually and installation guide. So why not name
> it FPC_Installation_Guide.pdf
>
>
> Yes I know I can rename them locally, but I also thing it makes sense to
> give the documents better "default" names than ref, prog, user.
If there is a more or less consensus about such things, I don't see why
we couldn't rename them.
The names actually stem from the TP documentation, which was divided into 3
books:
Language Reference
User's manual
Programmer's manual
Michael.
More information about the fpc-pascal
mailing list