[postgis-devel] Documentation

Regina Obe lr at pcorp.us
Mon Sep 3 10:49:22 PDT 2018


Paolo
> 
> is there a special reason why the documentation root file is called
> postgis.html instead of an apparently more convenient index.html?
> 
[Regina Obe] 
I assume you are talking about the doc html tar ball?

> Also, breaking it into separate files, as e.g in PostgreSQL docs, would allow
> faster loading.
> 
> --
> Paolo Cavallini - www.faunalia.eu
> QGIS & PostGIS courses: http://www.faunalia.eu/training.html
[Regina Obe] 
The website one (except for the translations)  is already broken into separate files and I think the first page is called index.html

The reason why the tarred one aren't I'm not absolutely sure, but guessing the following reasons

1) The single is used to build the translations so we only have a single page for each of those, otherwise we'd have to have each translation in separate folders
2) It was a little easier for packaging to only have to worry about 1 file, though now that we have so many images, that reason is mostly 0'd out.
3) If you are working locally (where the assumption a large html file is not a big deal), it's easier for novices to do a search across the whole html page than individual pages.
Then again we have PDFs too so people who need to search might prefer that format anyway.


All that said, I'm not against splitting the packaged into multiple files or having it as an additional option for download.

Feel free to put in a ticket for that.

https://postgis.net/support/


Thanks,
Regina



More information about the postgis-devel mailing list