Skip to content

Commit

Permalink
docs: turn README.txt to README.md (#177)
Browse files Browse the repository at this point in the history
drop superfluous adjectives
  • Loading branch information
cjmamo authored Dec 12, 2021
1 parent 0401300 commit 818b712
Show file tree
Hide file tree
Showing 42 changed files with 100 additions and 101 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates the usage of SmooksComponent
About this example
==================
This is an example that illustrates the usage of SmooksComponent

See:
1. The "Main" class in src/main/java/example/Main.java.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates the usage of SmooksDataFormat. A DataFormat
About this example
==================
This is an example that illustrates the usage of SmooksDataFormat. A DataFormat
is a class that implements Camel's org.apache.camel.spi.DataFormat.

The following features are demonstrated:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates the usage of the Camel SmooksComponent.
About this example
==================
This is an example that illustrates the usage of the Camel SmooksComponent.
A SmooksComponent can be used in a Camel route like this:
<to uri="smooks://file:./smooks-config.xml"/>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates the usage of SmooksComponent
About this example
==================
This is an example that illustrates the usage of SmooksComponent

See:
1. The "Main" class in src/main/java/example/Main.java.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates how to
About this example
==================
This is an example that illustrates how to
configure Smooks to process CSV records into Java objects.

See:
Expand Down
6 changes: 3 additions & 3 deletions csv-to-java/README.TXT → csv-to-java/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates how to
About this example
==================
This is an example that illustrates how to
configure Smooks to process CSV records into Java objects.

See:
Expand Down
4 changes: 2 additions & 2 deletions csv-to-xml-2/README.TXT → csv-to-xml-2/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example extends the more basic "csv-to-xml" example by
demonstrating how to perform a transformation on the individual records
in the CSV set.
Expand Down
6 changes: 3 additions & 3 deletions csv-to-xml/README.TXT → csv-to-xml/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates how Smooks to
About this example
==================
This is an example that illustrates how Smooks to
configure in a non-XML stream reader (CSV) into Smooks.

This capability enables Smooks to be used for processing any
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how to configure Smooks to
process variable record CSV messages, where the first CSV field name
denotes the name for that record.
Expand Down
4 changes: 2 additions & 2 deletions dao-router/README.TXT → dao-router/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
TODO


Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to extract data from an EDI message
and load this data into a database, all without writing a single line of code
(except for the "Main" class that executes Smooks).
Expand Down
4 changes: 2 additions & 2 deletions drools-fusion/README.TXT → drools-fusion/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This is an example of how one can use Smooks to "feed" Drools Fusion with CEP
events. It's a full blown copy of the Drools Fusion Stock Ticker example from
the Drools project.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how to use the ModelBuilder class
to read and write an XML message type that contains multiple schema (xsd)
namespaces and/or multiple evolving schema versions.
Expand Down
4 changes: 2 additions & 2 deletions edi-to-java/README.TXT → edi-to-java/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example is an extension of the "edi-to-xml" example. It extends
that example to include Javabean Object Graph population from the same EDI
message.
Expand Down
4 changes: 2 additions & 2 deletions edi-to-xml/README.TXT → edi-to-xml/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how to hook the EdiSax (http://milyn.codehaus.org/EdiSax)
EDI parser into a Smooks based transform (filter operation). It's another example
of how non-XML streams can be processed by Smooks (see the "csv-to-xml" example).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example is an extension of the "edi-to-xml" example. It extends
that example to include Javabean Object Graph population from the same EDI
message.
Expand Down
4 changes: 2 additions & 2 deletions edifact-to-xml/README.TXT → edifact-to-xml/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This is an example of how to use Smooks to process a UN/EDIFACT message
Interchange and from it generate an XML stream that can then be processed
by standard XML tools (XSLT, XQuery etc) or by other Smooks components.
Expand Down
4 changes: 2 additions & 2 deletions file-router/README.TXT → file-router/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to split
a message into smaller messages and route the smaller messages
to file.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates how to
About this example
==================
This is an example that illustrates how to
configure Smooks to process fixed length records into Java objects.

See:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example shows how to use the <regex:reader> to process a somewhat arbitrary
flat file format. In this example we process a Log4J log file, splitting each log
out into a <log> record and then splitting each log into 4 fields for <time>,
Expand Down
6 changes: 3 additions & 3 deletions groovy/README.TXT → groovy/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates how Smooks can
About this example
==================
This is an example that illustrates how Smooks can
be used to perform fragment based transforms using Groovy.

In this example, we perform a DOM based manipulation of a Shopping
Expand Down
6 changes: 3 additions & 3 deletions java-basic/README.TXT → java-basic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very basic example that illustrates how Smooks can be
About this example
==================
This is an example that illustrates how Smooks can be
used to apply a Java based transform on a message fragment.

See:
Expand Down
4 changes: 2 additions & 2 deletions java-to-java/README.TXT → java-to-java/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to transform one Java
Object Graph to another Java Object Graph.

Expand Down
4 changes: 2 additions & 2 deletions java-to-xml/README.TXT → java-to-xml/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to transform a Java object graph
to XML. It shows how to use a JavaSource to supply a Java object graph to Smooks
for transformation.
Expand Down
4 changes: 2 additions & 2 deletions jms-router/README.TXT → jms-router/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to split
a message into smaller messages and route the smaller messages
to a JMS Destination.
Expand Down
7 changes: 3 additions & 4 deletions json-to-java/README.TXT → json-to-java/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates the use
of the JSON reader within Smooks
About this example
==================
This is an example that illustrates the use of the JSON reader within Smooks

For example purposes we created a JSON structure that can't
be parsed directly into a SAX stream. Several map keys contain
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example is exactly the same as the "model-driven-basic" example except that it
uses a "Virtual Model". This basically means that it uses Maps instead
of a real object model. You'll see that everything is the same
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how to perform a model driven transform using the
Smooks Javabean and Templating Cartridges. FreeMarker is used to perform
the templating.
Expand Down
4 changes: 2 additions & 2 deletions osgi/blueprint/README.TXT → osgi/blueprint/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
About This Example:
===================
About this example
==================
TODO: Add example description and usage.

4 changes: 2 additions & 2 deletions osgi/peaberry/README.TXT → osgi/peaberry/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This examples demonstrates the usage of Peaberry which is an extension library for Google Guice.
Peaberry does what SpringDM does for the Spring dependency injection framework. Among other things
Peabery enables you to inject OSGi services using plain Guice annotations.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
About This Example:
===================
About this example
==================
TODO: Add example description and usage.

6 changes: 3 additions & 3 deletions profiling/README.TXT → profiling/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a simple example that illustrates how Smooks can be
About this example
==================
This is an example that illustrates how Smooks can be
used to apply "profile" based transformations on a message.

Using profiles, you can share common transformation configurations
Expand Down
4 changes: 2 additions & 2 deletions sj-testimonial/README.TXT → sj-testimonial/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Usecase::
===================
About this example
==================
This use case transformation has been donated by the Swedish Railway (SJ) where
it is used to retrieve information about train compositions (rollingstock).
The data that is the source of the transformation "lives" in a mainframe computer
Expand Down
6 changes: 3 additions & 3 deletions validation-basic/README.TXT → validation-basic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very basic example that illustrates how Smooks can be
About this example
==================
This is an example that illustrates how Smooks can be
used to validate xml message fragments.

What this example illustrates is:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This examples shows how to use the Smooks XMLBinding class to read and write different
versions of an XML into a common Java Object model. This can then be used to transform
messages from one version to another by reading the XML into the common Java Object model using
Expand Down
4 changes: 2 additions & 2 deletions xml-read-write/README.TXT → xml-read-write/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This examples shows how to use the Smooks XMLBinding class to read and write an XML
message to and from a Java Object model.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example is exactly the same as "xml-to-java" accept that it
uses a "Virtual Model". This basically means that it uses Maps instead
of a real object model.
Expand Down
4 changes: 2 additions & 2 deletions xml-to-java/README.TXT → xml-to-java/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to perform an XML to Java Transform.
It also shows how the populated Object graph is then accessible outside Smooks via the
JavaResult instance.
Expand Down
6 changes: 3 additions & 3 deletions xslt-basic/README.TXT → xslt-basic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very basic example that illustrates how Smooks can be
About this example
==================
This is an example that illustrates how Smooks can be
used to apply an XSLT based transform on a message fragment.

See:
Expand Down
4 changes: 2 additions & 2 deletions xslt-groovy/README.TXT → xslt-groovy/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Example:
===================
About this example
==================
This example illustrates how Smooks can be used to combine Groovy scripting
with XSLT to perform an Order message transform.

Expand Down
6 changes: 3 additions & 3 deletions xslt-namespaces/README.TXT → xslt-namespaces/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very basic example that illustrates how Smooks can be
About this example
==================
This is an example that illustrates how Smooks can be
used to apply an XSLT based transform on a message fragments that
use namespaces.

Expand Down
6 changes: 3 additions & 3 deletions yaml-to-java/README.TXT → yaml-to-java/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About This Example:
===================
This is a very simple example that illustrates the use
About this example
==================
This is an example that illustrates the use
of the YAML reader within Smooks

The following features are demonstrated:
Expand Down

0 comments on commit 818b712

Please sign in to comment.