[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

Re: Processing instruction guidelines


sample of instruction
I try to use processing instructions only for things that are really
specific to one and only one application and that are not intrinsic to
the document's content. I prefer to put anything that:
   - should be used by more than one application,
   - would be useful in the future (when other tools may be used), or
   - is a real part of the information, 
into the element/attribute structure of the document. 

I like to use processing instructions for information I want to "hide" 
from (some) XML applications, but that should be available other 
tools.

One use of PIs that we at Mulberry use a lot is in sample documents.
We want the samples of documents we provide with DTDs and Schemas to
be valid (of course).  But we also want to display parts of the
documents at appropriate places in the application documentation. 
We put processing instructions in the samples to specify which
portion(s) of each sample should be displayed in the documentation.
This leaves us with samples that are still valid according to the 
schema/DTD we are documenting, but we that we can manipulate as
needed. It's a major timesaver as the Schema/DTD changes and we want
to re-validate all of the samples.

I think it is generally bad practice to use PIs for things that many/any 
application(s) manipulating the content will need access to (for example, 
graphics placement instructions). It is good practice to use them for 
one-time use application-specific information (for example, in many 
situations, forced column-breaks and over-rides to hyphenation/justification
programs). 

-- Tommie


-- 
====================================================================== 
B. Tommie Usdin                        mailto:btusdin@m...
Mulberry Technologies, Inc.                http://www.mulberrytech.com    
17 West Jefferson Street                           Phone: 301/315-9631 
Suite 207                                    Direct Line: 301/315-9634 
Rockville, MD  20850                                 Fax: 301/315-8285 
----------------------------------------------------------------------
  Mulberry Technologies: A Consultancy Specializing in SGML and XML               
======================================================================

PURCHASE STYLUS STUDIO ONLINE TODAY!

Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
Email
First Name
Last Name
Company
Subscribe in XML format
RSS 2.0
Atom 0.3
 

Stylus Studio has published XML-DEV in RSS and ATOM formats, enabling users to easily subcribe to the list from their preferred news reader application.


Stylus Studio Sponsored Links are added links designed to provide related and additional information to the visitors of this website. they were not included by the author in the initial post. To view the content without the Sponsor Links please click here.

Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.