[postgis-devel] Documenting Aliases

Kevin Neufeld kneufeld at refractions.net
Mon Jul 28 10:49:17 PDT 2008


I don't think there is, but I'm not sure.  My understanding is that TOC 
is automatically generated by picking out the refname in the refnamediv 
tag in a refentry.  You can provide multiple refnames, but only the 
first one is picked out for use in the TOC.

Since we want to see these functions listed in the TOC, I don't see any 
other way than to treat them as the others with a See Also section.

Cheers,
Kevin

Obe, Regina wrote:
> We have a couple of aliases for functions such as 
> ST_WKTToSQL
> ST_WKBToSQL
> 
> Is there an easy way to give things like ST_GeomFromText 2 references.
> 
> It seems kind of silly to have to document both variants on separate
> pages although both should probably be listed in the TOC. I'm not sure
> if one name is preferred over another (though I would guess
> ST_GeomFromText would be the preferred).
> 
> Thanks,
> Regina
> 
> 
> -----------------------------------------
> The substance of this message, including any attachments, may be
> confidential, legally privileged and/or exempt from disclosure
> pursuant to Massachusetts law. It is intended
> solely for the addressee. If you received this in error, please
> contact the sender and delete the material from any computer.
> 
> _______________________________________________
> postgis-devel mailing list
> postgis-devel at postgis.refractions.net
> http://postgis.refractions.net/mailman/listinfo/postgis-devel



More information about the postgis-devel mailing list