Mike,
to prevent page label collisions I have started using page label prefixes for app-schema. For example, instead of labelling data/app-schema/installation.rst "_installation" I have labelled it "_app_schema_installation", as this is an obvious case where a collision would otherwise occur. I have been consistent and used "_app_schema" as a page label prefix all pages in data/app-schema .
Technically, this breaks the style guide, so I thought I had better announce my nonconforming practice and seek forgiveness.
Kind regards,
--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Earth Science and Resource Engineering
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia
Sounds good, although I think you may want to consider the module syntax used by sphinx:
http://sphinx.pocoo.org/modindex.html
Which would mean _app_schema.installation would be the new label. To take it all the way would involve the use of the .. module:: directive as well.
Just thought i would point it out since that is the convention that projects using sphinx, including sphinx itself, seem to use.
-Justin
Ben Caradoc-Davies wrote:
Mike,
to prevent page label collisions I have started using page label prefixes for app-schema. For example, instead of labelling data/app-schema/installation.rst "_installation" I have labelled it "_app_schema_installation", as this is an obvious case where a collision would otherwise occur. I have been consistent and used "_app_schema" as a page label prefix all pages in data/app-schema .
Technically, this breaks the style guide, so I thought I had better announce my nonconforming practice and seek forgiveness.
Kind regards,
--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
hey.
wondering if this is a moving forward change, or should we update previous pages in this way, as well.
hope everyone is well,
alyssa.
Justin Deoliveira wrote:
Sounds good, although I think you may want to consider the module syntax used by sphinx:
http://sphinx.pocoo.org/modindex.html
Which would mean _app_schema.installation would be the new label. To take it all the way would involve the use of the .. module:: directive as well.
Just thought i would point it out since that is the convention that projects using sphinx, including sphinx itself, seem to use.
-Justin
Ben Caradoc-Davies wrote:
Mike,
to prevent page label collisions I have started using page label prefixes for app-schema. For example, instead of labelling data/app-schema/installation.rst "_installation" I have labelled it "_app_schema_installation", as this is an obvious case where a collision would otherwise occur. I have been consistent and used "_app_schema" as a page label prefix all pages in data/app-schema .
Technically, this breaks the style guide, so I thought I had better announce my nonconforming practice and seek forgiveness.
Kind regards,
I think it would be nice to be consistent but not sure how others feel about it.
alyssa wright wrote:
hey.
wondering if this is a moving forward change, or should we update previous pages in this way, as well.
hope everyone is well,
alyssa.
Justin Deoliveira wrote:
Sounds good, although I think you may want to consider the module syntax used by sphinx:
http://sphinx.pocoo.org/modindex.html
Which would mean _app_schema.installation would be the new label. To take it all the way would involve the use of the .. module:: directive as well.
Just thought i would point it out since that is the convention that projects using sphinx, including sphinx itself, seem to use.
-Justin
Ben Caradoc-Davies wrote:
Mike,
to prevent page label collisions I have started using page label prefixes for app-schema. For example, instead of labelling data/app-schema/installation.rst "_installation" I have labelled it "_app_schema_installation", as this is an obvious case where a collision would otherwise occur. I have been consistent and used "_app_schema" as a page label prefix all pages in data/app-schema .
Technically, this breaks the style guide, so I thought I had better announce my nonconforming practice and seek forgiveness.
Kind regards,
------------------------------------------------------------------------------
Come build with us! The BlackBerry® Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9-12, 2009. Register now!
http://p.sf.net/sfu/devconf
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
Hi Ben.
Interesting. We should definitely change the style guide, because not only does this make total sense, it's what I've been doing with every page I work on!
I'll update the docguide...
Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org
Ben Caradoc-Davies wrote:
Mike,
to prevent page label collisions I have started using page label prefixes for app-schema. For example, instead of labelling data/app-schema/installation.rst "_installation" I have labelled it "_app_schema_installation", as this is an obvious case where a collision would otherwise occur. I have been consistent and used "_app_schema" as a page label prefix all pages in data/app-schema .
Technically, this breaks the style guide, so I thought I had better announce my nonconforming practice and seek forgiveness.
Kind regards,
Thanks, Justin, that sounds like a good idea. I will also start to use "-" in labels where they are present in the file name, instead of replacing "-" with "_"; I was under the misapprehension that labels needed underscores, because they start with one, but this is not the case. Only the leading "_" is magic. (The GeoServer style guide has underscore, but that is for a filename with underscores.)
app-schema/installation.rst -> _app-schema.installation
app-schema/complex-features.rst -> _app-schema.complex-features
That is much easier to read.
Kind regards,
Ben.
On 24/09/09 20:09, Justin Deoliveira wrote:
Sounds good, although I think you may want to consider the module syntax
used by sphinx:
http://sphinx.pocoo.org/modindex.html
Which would mean _app_schema.installation would be the new label. To
take it all the way would involve the use of the .. module:: directive
as well.
Just thought i would point it out since that is the convention that
projects using sphinx, including sphinx itself, seem to use.
-Justin
Ben Caradoc-Davies wrote:
Mike,
to prevent page label collisions I have started using page label
prefixes for app-schema. For example, instead of labelling
data/app-schema/installation.rst "_installation" I have labelled it
"_app_schema_installation", as this is an obvious case where a collision
would otherwise occur. I have been consistent and used "_app_schema" as
a page label prefix all pages in data/app-schema .
Technically, this breaks the style guide, so I thought I had better
announce my nonconforming practice and seek forgiveness.
Kind regards,
--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Earth Science and Resource Engineering
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia