Skip to content

Commit

Permalink
Changed paradigm of project to generation of Html files.
Browse files Browse the repository at this point in the history
Rewrote all unzipping scripts to generate Html files using Xalan rather than generating XSLT-linked XML files. This obviates need for a specially-configured web browser or specialized software for viewing, and provides completely portable generated files.

Also, deleted files rendered unnecessary by the script changes and rewrote README.md to accord with the new paradigm.
  • Loading branch information
dfyockey committed Aug 17, 2020
1 parent c97471d commit 764d3ed
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 419 deletions.
90 changes: 19 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,53 +19,15 @@ README for XSLT_PEDS

The following software is required or recommended for use with XSLT_PEDS:

- Chromium web browser or Chrome web browser (required)
- Xalan (listed in package managers as 'xalan-c', required)
- Xerces (listed in package managers as 'xerces-c', required)
- unzip (required)
- zenity (recommended)

Setup and use through a file manager are recommended for most users,
but a terminal may instead be used if desired.


** Before Setup **

If you are using the Gnome Files file manager (and perhaps other FMs),
you may need to change a preference to enable running SETUP and other
XSLT_PEDS files from your file manager.

In Gnome Files:

1. Click ☰

2. Click "Preferences"

3. Click "Behavior"

4. Under "Executable Text Files", select either "Run them" or
"Ask what to do", whichever you prefer.

5. Close the "Preferences" window.

Note: Nothing tragic will happen if you try to running SETUP and the
file mamager isn't able to do it. It'll just open a text editor
showing program code.


** Setup **

1. Unzip the downloaded XSLT_PEDS zip file into your Home folder to
create a folder with a name that begins with XSLT_PEDS.

2. Rename the folder to `XSLT_PEDS`.

3. Open the XSLT_PEDS folder and run the file SETUP.

4. If SETUP completes, a "SETUP Complete!" notification should pop up.
A message box may also pop up with advice on how to resolve any issues.

5. To test the setup, open the file TEST.xml. Either Chromium or Chrome
should open and display formatted data for the patent document
"MUSICAL INSTRUMENT SUPPORT".
Simply unzip the downloaded XSLT_PEDS zip file into folder of your choice.


** Usage **
Expand All @@ -80,20 +42,22 @@ README for XSLT_PEDS
4. Run the unzipping script of your choice depending on the desired
form of the results:

unzipa - Unzip All: Unzips a PEDS collection of Xml files to the
current folder while insuring each file has unique name.
unzipa - Unzip All: Unzips a PEDS collection of Xml files and
creates from them a collection of Html files in the
XSLT_PEDS folder, each Html file having a unique name.

unzipf - Unzip to Folder: Unzips a PEDS collection of Xml files
to a folder while insuring the folder is uniquely named.
and creates from them a collection of Html files in a
new folder having a unique name.

unzipo - Unzip to One - Unzips a PEDS collection of Xml files
and combines them into one uniquely-named Xml file.
and combines them into one uniquely-named Html file
located in the XSLT_PEDS folder.

When run, the choosen unzipping script will act on the latest .zip
file it finds in the XSLT_PEDS folder. The Xml file, files, or folder
containing Xml files should appear in the XSLT_PEDS folder. Each of
these files differs from a simply unzipped file in the addition of
a link required to enable formatting in a properly-configured browser.
file it finds in the XSLT_PEDS folder. The Html file, files, or
folder containing Html files should appear in the XSLT_PEDS folder.
Each of these files is formatted for viewing in any modern browser.

Additionally, the downloaded .zip file should disappear and, if not
already there, a zipTrash folder should appear. The unzipping
Expand All @@ -106,31 +70,15 @@ README for XSLT_PEDS
may alternatively be provided as an argument to any of the unzipping
scripts

5. Open one of the generated Xml files to view the formatted PEDS data.
5. Open one of the generated Html files to view the formatted PEDS data.

6. Depending on the file manager used, you may be able to select
multiple generated Xml files and hit "Enter" -- or open a context
multiple generated Html files and hit "Enter" -- or open a context
menu (i.e. "right-click menu") and click "Open" -- to open the files
to view the formatted PEDS data in a collection of (randomly-ordered)
tabs.


** Cavaet - Portability **

To view the Xml files generated by the unzipping scripts with formatting,
they must be in a folder containing either the peds.xsl file, a copy of
that file, or a link to that file. Consequently, the generated Xml files
can't generally be moved to another folder.

On the other hand, a *folder* generated by unzipf *can* be moved to
another folder and the generated Xml files it contains *can* still be
viewed with formatting. This is because each folder is created with a
link to peds.xsl. (For those techies out there that care... Yes, It's
an absolute symlink so as to enable moving it anyplace on the system.)

Due to the need for a properly configured browser, neither the generated
Xml files nor folders containing them are generally portable to another
computer while still being viewable with formatting.
in a collection of (randomly-ordered) tabs.

7. The Html files are completely portable (i.e. you can move them to
any folder, email them to someone, etc.)

<hr />

Expand Down
69 changes: 0 additions & 69 deletions SETUP

This file was deleted.

185 changes: 0 additions & 185 deletions TEST.xml

This file was deleted.

Loading

0 comments on commit 764d3ed

Please sign in to comment.