Hi everyone,

The subject of thoughtfully choosing names for URIs in MarkLogic is
not one that I've seen discussed, but I believe that it has a worthy
place in planning MarkLogic-based applications.

As we are well-aware, URIs are used in the context of MarkLogic for
module namespaces, XML namespaces, collections, directories, and
individual documents (among other uses; I think those are probably the
most important for this topic).

I am considering establishing some internal URI naming conventions
(not hard and fast rules, but more along the lines of helpful
guidelines).  My goal is to encourage consistency so there will be
less deliberation about what URI to use, less naming conflict, and so
that naming will follow expectations.  For example, it would be nice
if, by looking at a URI, it is clear what type of URI it is
(directory, collection, etc.).  I would document the conventions with
respect to each kind of URI (e.g. directory URIs might follow the form
"http://<organizational domain>/directory/<directory name>" and other
URIs would have their own forms).

I'd like to ask the group two specific questions about this topic:
(1) Do you use internal naming conventions for MarkLogic URIs at your
organization?  If so, how's it working out?
(2) Do you see value in having such conventions (realize that I'm not
suggesting hard-and-fast rules, just naming guidelines.  Deviations
from the conventions would be fine as long as they are justified.)?

Any other thoughts on the topic?

Thanks for your input,
Karl
_______________________________________________
General mailing list
[email protected]
http://xqzone.com/mailman/listinfo/general

Reply via email to