[Openstack-docs] Conventions for filenames and chapter/section IDs
Andreas Jaeger
aj at suse.com
Sun May 25 19:50:27 UTC 2014
On 05/24/2014 04:45 PM, Matt Kassawara wrote:
> Would consistently indicating type within an ID help clarify references?
> For example, chapter IDs always start with "ch_", section IDs always
> start with "sec_", figure IDs start with "fig_", etc.
Yeah, that would help.
When I add xml:ids, I normally use sec_FILENAME for the first section
and sec_FILENAME_TITLE for any additional sections. FILENAME is either
the filename or the first title.
I don't think we should remain now everything - but we should have a
rule for new files and new xml:ids moving forward. Remaining has the
problem that it creates new URLs and the old ones stay. Once that issue
is fixed, we can rename more easily,
Andreas
--
Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
More information about the Openstack-docs
mailing list