DITA file naming conventions

[Roger Shuttleworth]

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
  _____  

From: Jim Owens [mailto:jowens at magma.ca]
To: Roger Shuttleworth [mailto:rshuttleworth at avbasesystems.com]
Cc: framers at lists.frameusers.com
Sent: Thu, 03 Nov 2011 14:04:54 -0400
Subject: Re: DITA file naming conventions

 >   As far as possible, make sure the file name matches the title of 
  the topic. So if your topic is "Inserting the Widget" then your file 
  name would be "inserting_the_widget.xml". I realize this may cause 
  problems later if the title changes, but that doesn't happen often and 
  you can usually make the change to the file name without too much hassle 
  (changing it in ditamaps, etc.).
   >
  
  Since this has come up, I was wondering if any DITA-aware CMS offerings 
  can present the topic title or map title for selection by the user, 
  instead of the file name.  This would support the use of GUIDs for the 
  file names, which would guarantee uniqueness, and allow users to adjust 
  titles without having to manage ditamaps, related-links, or xrefs.
  
  _______________________________________________
  
  
  You are currently subscribed to framers as rshuttleworth at avbasesystems.com.
  
  Send list messages to framers at lists.frameusers.com.
  
  To unsubscribe send a blank email to
  framers-unsubscribe at lists.frameusers.com
  or visit http://lists.frameusers.com/mailman/options/framers/rshuttleworth%40avbasesystems.com
  
  Send administrative questions to listadmin at frameusers.com. Visit
  http://www.frameusers.com/ for more resources and info.
    
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20111103/b6e6c357/attachment.htm>