analytics/msgsdk/LocalizationSpec.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--
	Licensed Materials - Property of IBM

	IBM Cognos Products: localizationkit

	(C) Copyright IBM Corp. 2005, 2010

	US Government Users Restricted Rights - Use, duplication or disclosure restricted 
	by GSA ADP Schedule Contract with IBM Corp.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
	<xs:element name="messageFiles">
		<xs:annotation>
			<xs:documentation/>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence maxOccurs="unbounded">
				<xs:element name="messageFile">
					<xs:annotation>
						<xs:documentation>The messageFile element describes all transformations applied to a particular instance of a CCL Input Resource File that conforms to the CCLMessageFile.xsd schema and to where in the product the resulting consumable localized resource should be placed.
</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="transformations">
								<xs:complexType>
									<xs:sequence maxOccurs="unbounded">
										<xs:element name="transformation">
											<xs:annotation>
												<xs:documentation>Describes the process by which the CCL Input Resource File is transformed to a runtime consumable resource.

Choose the transformation from the enumeration provided by the 'process'
attribute. The generic 'xslt' transformation, which provides the ability for a component to supply their own specialized transformation, will require you to provide further information by specifying an xsltOptions element.</xs:documentation>
											</xs:annotation>
											<xs:complexType>
												<xs:all>
													<xs:element name="targetDirs">
														<xs:complexType>
															<xs:sequence maxOccurs="unbounded">
																<xs:element name="targetDir">
																	<xs:complexType>
																		<xs:attribute name="type" use="optional" default="Release">
																			<xs:annotation>
																				<xs:documentation>Specifies if this target specification is for Debug or Release (default).

The LDK processes only Release target specifications by default. You can override this by setting the Generate property of the LDK to one of "Debug", "Release", or "All".
</xs:documentation>
																			</xs:annotation>
																			<xs:simpleType>
																				<xs:restriction base="xs:string">
																					<xs:enumeration value="Debug"/>
																					<xs:enumeration value="Release"/>
																				</xs:restriction>
																			</xs:simpleType>
																		</xs:attribute>
																		<xs:attribute name="dir" use="required">
																			<xs:annotation>
																				<xs:documentation>Location into which the resulting transformed file is to be installed.
This path is expected to be relative to the product installation location.

Typical locations are

    bin
    cgi-bin
    webapps/p2pd/WEB-INF/classes</xs:documentation>
																			</xs:annotation>
																			<xs:simpleType>
																				<xs:restriction base="xs:string">
																					<xs:pattern value="[^\\]+"/>
																				</xs:restriction>
																			</xs:simpleType>
																		</xs:attribute>
																	</xs:complexType>
																</xs:element>
															</xs:sequence>
														</xs:complexType>
													</xs:element>
													
												    <xs:element name="customOptions" minOccurs="0">
                                                        <xs:annotation>
                                                            <xs:documentation>Provides information for applying a custom process in the event that the process attribute of the parent transformation element is set to 'custom'</xs:documentation>
                                                        </xs:annotation>
                                                        <xs:complexType>
                                                            <xs:sequence>
                                                                <xs:annotation>
                                                                    <xs:documentation>Provides context from LDKSpec to applicable custom impl of of com.cognos.localizationkit.ExternalProcess</xs:documentation>
                                                                </xs:annotation>
                                                                <xs:element name="properties"/>
                                                            </xs:sequence>
                                                            <xs:attribute name="impl" use="required">
                                                                 <xs:annotation>
                                                                    <xs:documentation>The impl determines the java implementation of com.cognos.localizationkit.ExternalProcess to call.</xs:documentation>
                                                                </xs:annotation>
                                                                <xs:simpleType>
                                                                    <xs:restriction base="xs:string">
                                                                        <xs:pattern value="[a-zA-Z0-9.]+"/>
                                                                    </xs:restriction>
                                                                </xs:simpleType>
                                                             </xs:attribute> 
                                                             <xs:attribute name="targetFileType" use="required">
                                                                <xs:annotation>
                                                                    <xs:documentation>The target file type determines what implicit processing is required.</xs:documentation>
                                                                </xs:annotation>
                                                                <xs:simpleType>
                                                                    <xs:restriction base="xs:string">
                                                                        <xs:pattern value="[a-zA-Z0-9]+"/>
                                                                    </xs:restriction>
                                                                </xs:simpleType>
                                                            </xs:attribute>
                                                            <xs:attribute name="targetFileExtension" use="required">
                                                                <xs:annotation>
                                                                    <xs:documentation>The file extension to be appended to the resulting target file.</xs:documentation>
                                                                </xs:annotation>
                                                                <xs:simpleType>
                                                                    <xs:restriction base="xs:string">
                                                                        <xs:pattern value="\.[a-zA-Z0-9]+"/>
                                                                    </xs:restriction>
                                                                </xs:simpleType>
                                                            </xs:attribute>            
                                                        </xs:complexType>
                                                    </xs:element>
													<xs:element name="xsltOptions" minOccurs="0">
														<xs:annotation>
															<xs:documentation>Provides information for applying a generic XSLT script in the event that the process attribute of the parent transformation element is set to 'xslt'</xs:documentation>
														</xs:annotation>
														<xs:complexType>
															<xs:attribute name="script" use="required">
																<xs:annotation>
																	<xs:documentation>Name of an  XSLT script.
</xs:documentation>
																</xs:annotation>
																<xs:simpleType>
																	<xs:restriction base="xs:string">
																		<xs:pattern value=".+\.xslt?"/>
																	</xs:restriction>
																</xs:simpleType>
															</xs:attribute>
															<xs:attribute name="targetFileType" use="required">
																<xs:annotation>
																	<xs:documentation>The target file type determines what implicit processing is required.
XML                  - values must be made XML-safe
Java Properties - Unicode values must be written out as excape sequences since properties files must be ASCII. Note: if targetFileExtension is '.properties' then "Java Properties is implied.
Text                  - no special processing.</xs:documentation>
																</xs:annotation>
																<xs:simpleType>
																	<xs:restriction base="xs:string">
																		<xs:enumeration value="Java Properties">
																			<xs:annotation>
																				<xs:documentation>The target file is a Java Properites file. The target file must encode non-ASCII characters as escape sequences in order to support unicode characters.</xs:documentation>
																			</xs:annotation>
																		</xs:enumeration>
																		<xs:enumeration value="Text">
																			<xs:annotation>
																				<xs:documentation>The target file is a plain text file.</xs:documentation>
																			</xs:annotation>
																		</xs:enumeration>
																		<xs:enumeration value="XML">
																			<xs:annotation>
																				<xs:documentation>The target file contains XML text. The resulting file will be encoded as to be XML-safe.</xs:documentation>
																			</xs:annotation>
																		</xs:enumeration>
																	</xs:restriction>
																</xs:simpleType>
															</xs:attribute>
															<xs:attribute name="targetFileExtension" use="required">
																<xs:annotation>
																	<xs:documentation>The file extension to be appended to the resulting target file.</xs:documentation>
																</xs:annotation>
																<xs:simpleType>
																	<xs:restriction base="xs:string">
																		<xs:pattern value="\.[a-zA-Z0-9]+"/>
																	</xs:restriction>
																</xs:simpleType>
															</xs:attribute>
														</xs:complexType>
													</xs:element>
												</xs:all>
												<xs:attribute name="process" use="required">
													<xs:annotation>
														<xs:documentation>Transformation to be used in order to create the runtime consumable resource files. Select one of:

BMF
    binary message file.

CCLXmlToProperties.xslt
    Official XSLT script that produces a Java Properties file.

CCLXmlToProperties2.xslt
    Official XSLT script that produces a Java Properties file which escapes single quote.

CCLInputSource.xslt
    Official XSLT script that produces another CCL Input Resource File with all error messages prefixed with the standard error message prefix.

Copy
    Simply copies the CCL Input Resource File.

xslt
    Alternate XSLT script. You must describe this script using the xsltOptions element.</xs:documentation>
													</xs:annotation>
													<xs:simpleType>
														<xs:restriction base="xs:string">
															<xs:enumeration value="BMF"/>
															<xs:enumeration value="CCLInputSource.xslt"/>
															<xs:enumeration value="CCLXmlToProperties.xslt"/>
															<xs:enumeration value="CCLXmlToProperties2.xslt"/>
															<xs:enumeration value="Copy"/>
															<xs:enumeration value="xslt"/>
															<xs:enumeration value="custom"/>
														</xs:restriction>
													</xs:simpleType>
												</xs:attribute>
											</xs:complexType>
										</xs:element>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
						<xs:attribute name="srcDir" type="xs:string" use="optional" default=".">
							<xs:annotation>
								<xs:documentation>Location of this message file.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="baseName" use="required">
							<xs:annotation>
								<xs:documentation>CCL Resource Input File base name (i.e. without the locale specification).

For example cclbitmsgs</xs:documentation>
							</xs:annotation>
							<xs:simpleType>
								<xs:restriction base="xs:string">
									<xs:pattern value="[a-zA-Z0-9][a-zA-Z0-9_]*"/>
								</xs:restriction>
							</xs:simpleType>
						</xs:attribute>
						<xs:attribute name="component" use="required">
							<xs:annotation>
								<xs:documentation>The name of the component to which this message file belongs.
This should be the official component short-name.</xs:documentation>
							</xs:annotation>
							<xs:simpleType>
								<xs:restriction base="xs:string">
									<xs:pattern value="[a-zA-Z0-9][a-zA-Z0-9_]*"/>
								</xs:restriction>
							</xs:simpleType>
						</xs:attribute>
						<xs:attribute name="containsBrand" use="optional">
                            <xs:annotation>
                                <xs:documentation>Indicates whether this is a brandable resource.</xs:documentation>
                            </xs:annotation>
                            <xs:simpleType>
                                <xs:restriction base="xs:boolean"/>
                            </xs:simpleType>
                        </xs:attribute>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>