DITA file naming conventions

Jim Owens jowens at magma.ca
Thu Nov 3 12:08:06 PDT 2011


For what it's worth, the DITA Style Guide recommends using names that 
match the titles.

  It also recommends using the extensions .dita and .ditamap, instead of 
.xml. That way, you have more control over which tool opens the file, 
and you can distinguish the files from other xml files used in DITA.

On 2011-11-03 15:02, Roger Shuttleworth wrote:
> Hi Jim
>
> You make a good point about updating xrefs and related-links, as well 
> as ditamaps, when a file name changes.
>
> I have made good use of the map checking function in oXygen Author. 
> You open the map in Author, then run it through an automated checking 
> routine that will point out any problems such as missing files or 
> inappropriate href values.
>
> I sent a follow-up message to the original poster correcting my 
> recommendation to use folders named according to deliverables. I meant 
> to recommend using the product name, not the deliverable. Different 
> deliverables are created from a single pool of files, using different 
> maps; or perhaps using the same map filtered by ditaval.
>
> Thanks for your tip about GUIDs too. I will look more into that.
>
> Roger Shuttleworth
> Technical Documentation
> AV-BASE Systems Inc.
> 1000 Air Ontario Drive, Suite 200
> London, Ontario
> N5V 3S4
> Tel. 519 691-0919 ext. 330
>
>     ------------------------------------------------------------------------
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20111103/7f94ff51/attachment.htm>


More information about the framers mailing list