World intellectual property organization special union for the international patent classification




Дата канвертавання26.04.2016
Памер60.36 Kb.


WORLD INTELLECTUAL PROPERTY ORGANIZATION

SPECIAL UNION FOR THE INTERNATIONAL PATENT CLASSIFICATION

(IPC UNION)

Split Software Guide



Date

By

Version

Status

Modification

February 16, 2005

Törcsvári

1.0




Creation

February 16, 2005

Fiévet

1.1




Review

August 10, 2005

Törcsvári

1.2




Double option

November 24, 2005

Moles

1.3




Review

October 14, 2005

Moles

1.4




Unzip warning

November 21, 2005

Törcsvári

1.5




Adding switches

November 23, 2005

Molés

1.6




Review

November 23, 2005

Fiévet

1.7

Approved

intention

Contact: WIPO: Patrick FIÉVET (patrick.fievet@wipo.int)

Table of Contents

Split Software Guide i

1. Introduction 3

2. Technology and requirements 3

3. The software package 4

3.1. Installation 4

3.2. Content of the package 4

4. Launching ripcis-split.js 5

4.1. Starting ripcis-split.js 5

4.2. Parameters of ripcis-split.js 5

5. Launching ripcis-split in batch mode 7

6. How does it work? 8

6.1. Creation/checking output folders 8

6.2. Copying viewer files 8

6.3. Splitting, verification and conversion of files 8

6.4. Creation of the index file 8

7. Output of ripcis-split 8

7.1. Xml folder 9

7.2. htm folder 9

8. Notes 9


Table of Figures

Figure 1 Winzip window 4

Figure 2 –Parameters of ripcis-split 5



List of Tables

Table 1 - Physical space requirements 3

Table 2 – ripcis-split input parameters 6




1.Introduction


The RIPCIS — Reformed IPC Information System — output file for the IPC Scheme is a single XML file, that contains the advanced and core level of IPC in English and French.

This large output file is not intended for immediate browsing; the main purpose of this file is the exchange with Information systems in Intellectual Property offices. It allows further conversion of the scheme into other formats.

The original intention of the spit tool was browsing of the reformed IPC scheme after splitting of the huge XML scheme file into smaller XML or HTML files and introduction of a specific style sheet for viewing. This scope was later extended to providing an illustration of the way XML scheme file could be processed to produce specific ways to visualize the content of the scheme file.

For this reason the source code of the split tool is available to offices as example or basis for possible modification in view of customization for their specific requirements.

The split utility creates, based on parameters, one 'split' and transformation of the input XML file. The split can contain 'advanced' or 'core' level, in English or French, split at section, class or subclass.1

The splitting utility also presents a possible way of processing the XML file. In spite of the original intention — the file must be processed using single-pass readers/converter interfaces like SAXthe utility shows, that the file can be processed with DOM tools as well.


2.Technology and requirements


The splitter tool is developed and intended to be used in Windows environment, using Jscript technology and MSXML 4.0 SP2.

The current security settings allow running of the script using the cscript2 interpreter. The cscript interpreter must be available, i.e. the Windows Scripting Host with its command line tools must be installed properly.



Table 1 - Physical space requirements




Advanced

Core

Triple-language version

Memory t

256 MB free physical memory

512 MB free physical memory

Hard disk










Source XML

< 100 MB

<150 MB

Split XML files

< 60 MB / split

< 25 MB

< 200 MB / split

Split HTML files

< 200 MB / split

< 80 MB




Total for all splits in all languages

< 2290 MB

< 3.5 GB


3.The software package

3.1.Installation


Unzip the package with directory structure in a new folder. Note that the option “Use folder names” must be selected in the extraction window like shows Figure 1. You will see two program files and two folders.

Figure 1 Winzip window


3.2.Content of the package


The software package contains the following files:

  • ripcis-split.js: main program file for the splitter utility.

  • ipc8split_all.bat: batch file to call the utility for all possible splits (refer for more details)

  • xmlviewer\*.*: folder containing all necessary XSL, JS and CSS files for the presentation of XML files. It also contains images that are embedded into the text of IPC.

  • htmviewer\*.*: folder containing all necessary JS and CSS files for the presentation of HTML files. It also contains images that are embedded into the text of IPC.

4.Launching ripcis-split.js

4.1.Starting ripcis-split.js


  1. Open a command line terminal on Windows.

  2. Type cscript ripcis-split.js (without parameters)

4.2.Parameters of ripcis-split.js


When starting ripcis-split.js without parameters, a usage information message is presented (see Figure 2):

Figure 2 –Parameters of ripcis-split

The parameters are the following:

Table 2 – ripcis-split input parameters

Name

Description

Possible values

InputFile

The input XML file, with full path information.

Note: The same folder must contain the ipcr_scheme_1-02.dtd DTD file.






OutputFolder

The folder where the results will be stored. Use standard Windows folder syntax, do not put '\' at the end. The folder, in principle, should be a non-existing one. On subsequent launching (of the same split) the same folder can be reused in case one of -standardfolders or  fixedfolders options were provided.3




-split

Hierarchical level where to split the files

section

class


subclass

-level

Level of IPC to present into the files

core

advanced


-lang

Language

The language in the “translation” element can be also used.



en | fr | es

-configcopy (opt)

If provided, it copies the configuration files but it generates no output.




-html (opt)

If parameter provided, it generates in addition to XML, the HTML files into the htm folder.




-double (opt)

If provided, it generates references to the other national language(s) versions; therefore generated HTML files will contain jumps to other levels and languages

see below the ‘languages’ option






-encoding=utf-16 (opt); default encoding: UTF-8

set encoding to utf-16

utf-16

-fixedfolders (opt)

If provided, the files are generated in a fixed folder architecture under the output folder:

edition\split\level\lang\xml

and, if –html provided,

edition\split\level\lang\htm







-standardfolders

If provided, the files are generated in a standard, non-hierarchic folder architecture:

output-folder\
split-lang-level\xml etc.

standardfolders and fixedfolders options are exclusive.




-headeronly (opt)

If provided, the generated XML files do not contain redundant information such as section /class text in class/subclass files. They only contain the header for reference purposes




-languages (opt)

If provided, the generated XML files contain references/links to the other national languages in the list. Comma-separated list of languages without spaces.

EN,FR,ES

-xmlviewer (opt)

If provided, it adds the XSLT reference to the XML files to allow presentation of XML files in a browser.




-index (opt)

If provided, it generates XML and HTML index files.






Complete sample:

>> cscript ripcis-split.js ipcr_scheme_20050215.xml section-en-core -lang=en -split=section -level=core


5.Launching ripcis-split in batch mode


If the user wants to create the whole set of split files in a single step, then he must use the ipc8split_all.bat file from a command line window. There are several ways for executing it:

  1. Without parameters, it will take as XML input file the one in source\ipcr_scheme_20050421.xml and it will generate the split files for the subclass level in both languages.

  2. Passing the path to the input XML file. It will generate the split files for the subclass level in both languages

    >> ipc8split_all.bat “c:\Program Files\ipcr_scheme_20050803.xml”

  3. Passing the language (en | fr), it will generate the split files for every level (section, class and subclass) in the language chosen.

    >> ipc8split_all.bat “c:\Program Files\ipcr_scheme_20050803.xml” en

    >> ipc8split_all.bat en


6.How does it work?


When executing the script, it runs through the following steps:

6.1.Creation/checking output folders


The output folder will be created automatically. It will contain two subfolders, xml and htm, the xml subfolder will contain generated XML files, the htm subfolder the HTML files.

6.2.Copying viewer files


The content of the xmlviewer subfolder (of the package) is copied automatically to the xml folder, the content of the htmviewer subfolder (of the package) will be copied to the htm folder, to allow autonomous viewing.

6.3.Splitting, verification and conversion of files


In the same step, the following activities are done:

  • Creation of the XML files for hierarchical browsing of the final files (e.g. for A01B, the files containing class A01 and section A will be created).

  • Validation of the top-hierarchy files.

  • Conversion of the top-hierarchy files to HTML.

  • Creation of the split XML files, one for each split level.

  • Validation of the generated file.

  • Creation of the HTML files from the generated file.

6.4.Creation of the index file


Creation of the index XML and HTML files.

7.Output of ripcis-split


In the output folder, there will be two folders created, xml and htm, the xml subfolder will contain generated XML files, the htm subfolder the HTML files.

7.1.Xml folder


In the xml folder you will find:

  • XML files named according to the symbol of the hierarchical level according to the split level, e.g. for subclass split, by the symbol of subclasses
    naming convention: x99x.xml for subclass split, x99.xml for class split and x.xml for section split the file also contains the top hierarchy of the entry

  • XML files containing the top hierarchy according to the split level, e.g. for subclass split, section are created that contain only the text of the classes, and class files that contain only the text of its subclasses naming convention: x99.xml for subclass split, x.xml for subclass and class split

  • Index file that contains only the list of sections

  • Viewer files (XSLT, CSS, and JS).

7.2.htm folder


In the htm folder you will find:

  • HTML files as generated from the XML files within the ../xml folder

  • Viewer files (XSLT, CSS, and JS).

8.Notes


The Split tool consumes XML data that conforms to the ipcr_scheme_1-02.dtd but the data created using this tool does not conform to that DTD file. The reason is that the generated data contains different tags and attributes necessary for the visualization.

1 There are therefore 2 x 2 x 3 = 12 different splits

2 It is not recommended to use wscript as it would present software messages in alert boxes. Do not call the script without the interpreter, because, by default, the wscript interpreter is used.

3 From version to version it is recommended to use different folders to avoid mixture of the versions. In majority of the cases it causes no problem, because the files are overwritten, but when subclasses/classes are deleted, there might remain residues.



База данных защищена авторским правом ©shkola.of.by 2016
звярнуцца да адміністрацыі

    Галоўная старонка