This is an automated email from the ASF dual-hosted git repository.
wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openjpa-site.git
The following commit(s) were added to refs/heads/main by this push:
new 2f10216 OpenJPA Ready aside from apidocs
2f10216 is described below
commit 2f10216db7ffa82a6f9fe2c9e9356ef7e0656946
Author: Dave Fisher <[email protected]>
AuthorDate: Sun Jun 13 15:39:25 2021 -0700
OpenJPA Ready aside from apidocs
---
LICENSE | 202 +++++++++++++++++++
README.md | 6 +-
migration/README.md | 33 ++++
migration/changes.txt | 482 ++++++++++++++++++++++++++++++++++++++++++++++
theme/plugins/asfgenid.py | 60 ++++--
5 files changed, 763 insertions(+), 20 deletions(-)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
index b520d60..4e93e58 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,5 @@
-# Bootstrap
\ No newline at end of file
+# Pelican ASF Website
+
+See [ASF-Pelican](https://infra.apache.org/asf-pelican.html)
+
+See [migration notes](migration/README.md)
diff --git a/migration/README.md b/migration/README.md
new file mode 100644
index 0000000..391159e
--- /dev/null
+++ b/migration/README.md
@@ -0,0 +1,33 @@
+# CMS Migration
+
+1. Markdown conversions
+
+ - Rename from mdtext to md
+ - All files must have a title
+ - Switched some spans to divs
+ - Included alt text for images and switched some imag tags to markdown
+ - Cleaned up list indentation paticulatly in
./content/begin-using-openjpa---the-basics.md
+
+ See [changes.txt](changes.txt)
+
+2. Theme Template
+
+ CMS templates were converted into `base.html`
+
+3. Configuration
+
+ See [pelicanconf.py](../pelicanconf.py)
+
+4. Pelican ASF plugin configuration
+
+ [asfgenid.py](../theme/plugins/asfgenid.py)
+
+ - 'unsafe_tags': True # allow style, script, and iframe tags
+ - 'metadata': False # no metadata replacement in markdown files
+ - 'elements': False # CMS didn't use mdx_elementid featuresz
+ - 'headings': True # Fix up headings w/ permalinks
+ - 'headings_re': r'^h[1-4]'
+ - 'permalinks': True,
+ - 'toc': False # does not use [TOC]
+ - 'toc_headers': r"h[1-4]",
+ - 'tables': True # Fix up for markdown table class
diff --git a/migration/changes.txt b/migration/changes.txt
new file mode 100644
index 0000000..027064f
--- /dev/null
+++ b/migration/changes.txt
@@ -0,0 +1,482 @@
+==== ./content/logo-contest.md
+==== ./content/building-and-running-openbooks.md
+==== ./content/release-management.md
+==== ./content/jpa-2.0-iterations.md
+==== ./content/enhancement-with-ant.md
+==== ./content/detached.state.serialization.md
+==== ./content/openjpa-2.0.0-beta.md
+==== ./content/jsr-317-20081031-public-draft-tasks.md
+==== ./content/get-involved.md
+==== ./content/license.md
+==== ./content/openjpa-2.3.x.md
+==== ./content/jpa-2.1-test-coverage.md
+==== ./content/sidenav-quick-links.md
+==== ./content/openjpa-2.0.0.md
+==== ./content/domain-model-browser.md
+22c22,23
+< <span class="info">
+---
+> <div class="info">
+>
+25c26,27
+< </span>
+---
+>
+> </div>
+33c35
+< 
+---
+> 
+==== ./content/jpa-specification-development.md
+==== ./content/overview.md
+==== ./content/fetch-statistics.md
+==== ./content/troubleshoot.md
+==== ./content/jest-examples.md
+==== ./content/openjpa-2.0.1.md
+==== ./content/openjpa-2.1.0.md
+==== ./content/opentradercommunication.md
+==== ./content/jconsole-datacache-plugin.md
+==== ./content/powered-by.md
+==== ./content/integration.md
+==== ./content/jest-transaction.md
+==== ./content/jpa-2.1-development-process.md
+==== ./content/publishing-serp-to-maven-central-repository.md
+==== ./content/query-notes.md
+==== ./content/community.md
+==== ./content/privacy-policy.md
+==== ./content/openjpa+email.md
+==== ./content/apidiscussionfollowup.md
+==== ./content/openjpa-2.0.0-milestone-3.md
+==== ./content/banner.md
+==== ./content/update-release-text-files.md
+==== ./content/openjpa-2.0.0-early-access-2.md
+==== ./content/recovering-from-a-vetoed-release.md
+==== ./content/openjpa-3.1.x.md
+1c1
+< Title:
+---
+> Title: OpenJPA 3.1.X
+==== ./content/opentraderarchitecture.md
+==== ./content/samples.md
+==== ./content/jpa-2.0-development-process.md
+==== ./content/downloads-nightly.md
+==== ./content/openjpa-release-policy.md
+==== ./content/openjpa-2.0.0-beta-3.md
+==== ./content/enhancement-with-eclipse.md
+65c65
+< 
+---
+> 
+67c67
+< 
+---
+> 
+69c69
+< 
+---
+> 
+==== ./content/jest-representation.md
+==== ./content/entity-enhancement.md
+==== ./content/site-index.md
+==== ./content/openjpa-development-resources.md
+==== ./content/jpa-2.0-test-coverage.md
+==== ./content/intro.md
+==== ./content/mailing-lists.md
+==== ./content/openbooks---featuring-jpa-2.0.md
+==== ./content/begin-using-openjpa---the-basics.md
+83c83
+< <img src="images/image001.jpg"/>
+---
+> 
+93c93
+< <img src="images/image002.jpg"/>
+---
+> 
+98c98
+< <img src="images/image003.jpg"/>
+---
+> 
+104c104
+< <img src="images/image001.jpg"/>
+---
+> 
+108c108
+< <img src="images/image004.jpg"/>
+---
+> 
+113c113
+< <img src="images/image005.jpg"/>
+---
+> 
+119c119
+< <img src="images/image006.jpg"/>
+---
+> 
+123c123
+< <img src="images/image007.jpg"/>
+---
+> 
+130c130
+< <img src="images/image008.jpg"/>
+---
+> 
+136c136
+< <img src="images/image009.jpg"/>
+---
+> 
+138,141c138,140
+< 1. Now we will bring in the sample code. The easiest way to add the sample
+< code is to find the source provided with this tutorial and copy it to
+< the src folder under the **OpenJPATutorialWeb** folder in your project
+< directory in Windows Explorer:
+---
+> 1. Now we will bring in the sample code. The easiest way to add the sample
code is
+> to find the source provided with this tutorial and copy it to the src
folder
+> under the **OpenJPATutorialWeb** folder in your project directory in
Windows Explorer:
+143c142
+< <img src="images/image010.jpg"/>
+---
+> 
+145,147c144,145
+< * Now go back to Eclipse. Right-click on the **OpenJPATutorialWeb**
folder
+< in the Project Explorer view and select **Refresh,** or press the **F5** key
on
+< your keyboard. Now you will see this:
+---
+> * Now go back to Eclipse. Right-click on the **OpenJPATutorialWeb**
folder in the Project Explorer view
+> and select **Refresh,** or press the **F5** key on your keyboard. Now
you will see this:
+149c147
+< <img src="images/image011.jpg"/>
+---
+> 
+151,152c149
+< Notice that all the source files compile without error. That is
because
+< Geronimo comes with OpenJPA v1.1 built in.
+---
+> Notice that all the source files compile without error. That is because
Geronimo comes with OpenJPA v1.1 built in.
+156c153
+< <img src="images/image012.jpg"/>
+---
+> 
+160c157
+< <img src="images/image013.jpg"/>
+---
+> 
+169,170c166
+< 1. In Windows, open a command prompt and navigate to the Geronimo **bin**
+< directory.
+---
+> 1. In Windows, open a command prompt and navigate to the Geronimo **bin**
directory.
+175c171
+< <img src="images/image014.jpg"/>
+---
+> 
+179c175
+< <img src="images/image015.jpg"/>
+---
+> 
+183c179
+< <http://localhost:8080/console>
+---
+> http://localhost:8080/console
+185c181
+< <img src="images/image016.jpg"/>
+---
+> 
+189,191c185,186
+< 1. You will come to the Welcome page. On the left menu, at the bottom, find
+< the section for the Embedded DB. This is the Derby database control
+< page.
+---
+> 1. You will come to the Welcome page. On the left menu, at the bottom, find
the section
+> for the Embedded DB. This is the Derby database control page.
+193c188
+< <img src="images/image017.jpg"/>
+---
+> 
+197,199c192,193
+< 1. In the Run SQL section, in the text field labeled Create DB, type in
+< **StoreSystem**. This is the name of the database that the OpenJPA sample is
+< configured to transact.
+---
+> 1. In the Run SQL section, in the text field labeled Create DB, type in
**StoreSystem**.
+> This is the name of the database that the OpenJPA sample is configured to
transact.
+201c195
+< <img src="images/image018.jpg"/>
+---
+> 
+203,204c197
+< 1. Click on the **Create** button. You should now see the
+< **StoreSystem** database appear in
+---
+> 1. Click on the **Create** button. You should now see the **StoreSystem**
database appear in
+207c200
+< <img src="images/image019.jpg"/>
+---
+> 
+228c221
+< <img src="images/image020.jpg"/>
+---
+> 
+230,231c223
+< 1. In the Ear Export dialog, find a convenient place to put the
+< exported EAR file.
+---
+> 1. In the Ear Export dialog, find a convenient place to put the exported EAR
file.
+234c226
+< <img src="images/image021.jpg"/>
+---
+> 
+241c233
+< <img src="images/image022.jpg"/>
+---
+> 
+249c241
+< <img src="images/image023.jpg"/>
+---
+> 
+253c245
+< <img src="images/image024.jpg"/>
+---
+> 
+260c252
+< <img src="images/image025.jpg"/>
+---
+> 
+264c256
+< <img src="images/image026.jpg"/>
+---
+> 
+415c407
+< �
+---
+>
+418c410
+< �
+---
+>
+430c422
+< <img src="images/image027.jpg"/>
+---
+> 
+456,457c448
+< * **persistence-unit**: the **name** is the table name to bind. In this
case
+< it is 'person'.
+---
+> * **persistence-unit**: the **name** is the table name to bind. In this
case it is 'person'.
+459,461c450,451
+< * **property:** openjpa.jdbc.SynchronizeMappings: This tells OpenJPA to
+< automatically create the table with the class definition if a table does
+< not already exist.
+---
+> * **property:** openjpa.jdbc.SynchronizeMappings: This tells OpenJPA to
automatically create
+> the table with the class definition if a table does not already exist.
+465a456
+>
+480,485c471,473
+< * Note that the name, **"InventorySystem"**, is the same
+< one identified in the persistence.xml.
+< * This code can be placed just before a query or transaction or they can
+< be class properties.
+< * Regardless of the scope, the EntityManager and the EntityManagerFactory
+< should be closed when they are no longer needed:
+---
+> * Note that the name, **"InventorySystem"**, is the same one identified in
the persistence.xml.
+> * This code can be placed just before a query or transaction or they can
be class properties.
+> * Regardless of the scope, the EntityManager and the EntityManagerFactory
should be closed when they are no longer needed:
+492,501c480,486
+< * The EntityManagerFactory and EntityManager full descriptions are in the
+< following OpenJPA documentation:
+< * EntityManagerFactory:
<http://openjpa.apache.org/builds/latest/docs/manual/jpa_overview_emfactory.html>
+< * EntityManager:
<http://openjpa.apache.org/builds/latest/docs/manual/jpa_overview_em.html>
+<
+< * DB interface class. In this example, the InventoryEntityBroker class
+< contains all the OpenJPA database interaction code. This is not required
+< but it is a good idea for keeping the functionality componentized. For
+< example, if you want to pull all of the records from the InventoryItem
+< table, the code would look like this:
+---
+> * The EntityManagerFactory and EntityManager full descriptions are in the
following OpenJPA documentation:
+> * EntityManagerFactory:
http://openjpa.apache.org/builds/latest/docs/manual/jpa_overview_emfactory.html
+> * EntityManager:
http://openjpa.apache.org/builds/latest/docs/manual/jpa_overview_em.html
+>
+> * DB interface class. In this example, the InventoryEntityBroker class
contains all the OpenJPA database interaction code.
+> This is not required but it is a good idea for keeping the functionality
componentized. For example, if you want
+> to pull all of the records from the InventoryItem table, the code would
look like this:
+525,528c510,511
+< * Notice that the Query is not standard SQL. It is actually JPQL, which
is
+< a specialized form of query language specifically designed for JPA.
+< * In the JPQL statement, "<font color="#2a00ff">SELECT item FROM
InventoryItem
+< item</font>", notice that InventoryItem has the same case as the class
+---
+> * Notice that the Query is not standard SQL. It is actually JPQL, which is
a specialized form of query language specifically designed for JPA.
+> * In the JPQL statement, "<font color="#2a00ff">SELECT item FROM
InventoryItem item</font>", notice that InventoryItem has the same case as the
class
+530,531c513
+< * JPQL uses java objects in the query and not the database table
names.
+< The statement identifies the variable for InventoryItem as
+---
+> * JPQL uses java objects in the query and not the database table names.
The statement identifies the variable for InventoryItem as
+533,536c515,516
+< * JPQL provides an object oriented query language that is
independent of
+< the database being queried. So, regardless of which database being
+< used, the JPQL does not change. The JPA runtime takes care of doing
+< the translation from the object world to the desired relational database.
+---
+> * JPQL provides an object oriented query language that is independent of
the database being queried. So, regardless of which database being
+> used, the JPQL does not change. The JPA runtime takes care of
doing the translation from the object world to the desired relational database.
+539,542c519,520
+< * Also in the InventoryEntityBroker is code to add entries the database
+< tables. Since you did not create a table for InventoryItem in the
+< StoreSystem database in Derby, OpenJPA 2.0 will create the table the first
+< time an _"add"_ is attempted.
+---
+> * Also in the InventoryEntityBroker is code to add entries the database
tables. Since you did not create a table for InventoryItem in the
+> StoreSystem database in Derby, OpenJPA 2.0 will create the table the first
time an _"add"_ is attempted.
+575,576c553
+< * When this is executed the first time it will use the annotations to
+< create the Person table, then OpenJPA 2.0 will populate it with the
+---
+> * When this is executed the first time it will use the annotations to
create the Person table, then OpenJPA 2.0 will populate it with the
+578,579c555
+< * Note the use of the getTransaction() method to start an update and
then
+< to commit it. The concept is the same as in any database transaction
+---
+> * Note the use of the getTransaction() method to start an update and
then to commit it. The concept is the same as in any database transaction
+581,584c557,558
+< * Also note that while the getAllItems() function requires a JPQL
SELECT
+< query, the update type actions have APIs.
+< * Take a look in the InventoryEntityBroker code at the addItem(),
+< updateItem() and deleteItem() functions and note the simplicity of these
+---
+> * Also note that while the getAllItems() function requires a JPQL SELECT
query, the update type actions have APIs.
+> * Take a look in the InventoryEntityBroker code at the addItem(),
updateItem() and deleteItem() functions and note the simplicity of these
+589,590c563
+< and many to many. OpenJPA provides annotations to identify the related
+< fields.
+---
+> and many to many. OpenJPA provides annotations to identify the related
fields.
+607,608c580
+< * This object has a one-to-many relationship with
+< targetEntity=tutorial.InventoryItem.class. Meaning that one
+---
+> * This object has a one-to-many relationship with
targetEntity=tutorial.InventoryItem.class. Meaning that one
+610,613c582,583
+< * The property of InventoryItem that specifies the
+< InventoryCategory it is associated with is mappedBy="category". In other
+< words, InventoryItem has a class property of type InventoryCategory named
+< "category".\\ Now open the source file,
+---
+> * The property of InventoryItem that specifies the InventoryCategory it is
associated with is mappedBy="category". In other
+> words, InventoryItem has a class property of type InventoryCategory
named "category". Now open the source file,
+628,629c598
+< * This object has a many-to-one relationship with the
InventoryCategory
+< object. Meaning that there many InventoryItems can reference the same
+---
+> * This object has a many-to-one relationship with the InventoryCategory
object. Meaning that there many InventoryItems can reference the same
+631d599
+<
+634,635c602
+< reference by the attribute:
+< name=<font color="##2a00ff">"CAT_ID"</font>.
+---
+> reference by the attribute: name=<font
color="##2a00ff">"CAT_ID"</font>.
+==== ./content/bean-validation-primer.md
+==== ./content/releasing-openjpa-1.0.x-or-1.1.x-(old-scp-steps).md
+==== ./content/openjpa-logo-contest---round-1.md
+==== ./content/faq.md
+==== ./content/openjpa-confluence-user-groups.md
+==== ./content/tips-n-techniques.md
+==== ./content/quick-start.md
+==== ./content/releasing-openjpa-1.2.x-(old-scp-steps).md
+==== ./content/openjpa-up-close-and-personal.md
+==== ./content/obtaining.md
+==== ./content/jpa-2.1-roadmap.md
+==== ./content/testing.md
+==== ./content/openjpa-3.0.x.md
+==== ./content/build-and-runtime-dependencies.md
+4c4
+< <a name="OpenJPABuildandRuntimeDependencies></a>
+---
+> <a name="OpenJPABuildandRuntimeDependencies"></a>
+==== ./content/beginners-performance-guide.md
+==== ./content/openjpa-2.4.x.md
+==== ./content/openjpa-2.0.0-beta-2.md
+==== ./content/getting-started.md
+==== ./content/buildbot.tips.n.techniques.md
+==== ./content/openjpa-logo-contest---round-2.md
+==== ./content/opentraderserver.md
+==== ./content/whither-openjpa.md
+==== ./content/coding-standards.md
+==== ./content/thanks.md
+==== ./content/writing-test-cases-for-openjpa.md
+==== ./content/development-process.md
+==== ./content/running-the-sun-tck-for-jpa.md
+==== ./content/jest-syntax.md
+==== ./content/sidenav-community.md
+==== ./content/found-a-bug.md
+==== ./content/using-criteria-api-in-daytrader.md
+140c140
+< wsadmin -f <location ofdaytrader_singleServer.py> <script options>
+---
+> wsadmin -f <location ofdaytrader_singleServer.py> ${script options}
+148c148
+< 1. On a web browser, go to http://localhost:<application
port>/daytrader/(The default application port is 9080. But, you may have a
different one if you created a new profile.)
+---
+> 1. On a web browser, go to http://localhost:<application-port>/daytrader/
(The default application port is 9080. But, you may have a different one if you
created a new profile.)
+==== ./content/embeddable-samples.md
+==== ./content/findbugs-presentation-notes.md
+==== ./content/jpa-2.0-presentations.md
+==== ./content/index.md
+==== ./content/related-projects.md
+==== ./content/enhancement-with-maven.md
+==== ./content/opentrader.md
+==== ./content/openjpaeclipseinstallation.md
+7c7,8
+< <span class="info">
+---
+> <div class="info">
+>
+9c10,12
+< the current Update Site of the OpenJPA Eclipse Tooling. (It will
probably still change.)</span>
+---
+> the current Update Site of the OpenJPA Eclipse Tooling. (It will probably
still change.)
+>
+> </div>
+==== ./content/runtime-enhancement.md
+==== ./content/apply-an-eclipse-patch.md
+==== ./content/opentraderbuild.md
+==== ./content/openjpa-logo-contest---run-off.md
+==== ./content/opentraderdeploy.md
+==== ./content/opentraderenvironment.md
+==== ./content/2.1-roadmap.md
+==== ./content/jpa-2.0-tasks.md
+==== ./content/jpa-2.1-tasks.md
+==== ./content/sidenav-overview.md
+==== ./content/documentation.md
+==== ./content/sidenav-development.md
+==== ./content/release-artifact-locations.md
+==== ./content/source-code.md
+==== ./content/running-openjpa-examples.md
+==== ./content/architecture-notes.md
+==== ./content/jpa-m2-demo.md
+==== ./content/release-setup.md
+==== ./content/opentraderclient.md
+==== ./content/consumers.md
+==== ./content/downloads.md
+==== ./content/openjpaeclipsetoolingdevandbuild.md
+==== ./content/apache-nexus-release-process-(1.2.x-2.1.x).md
+==== ./content/websphere-application-server.md
+==== ./content/jpa-2.0-roadmap.md
+==== ./content/openjpa-2.2.0.md
+==== ./content/development.md
+==== ./content/openjpaeclipseenhancementbuilder.md
+==== ./content/jest-usage.md
+==== ./content/automated-builds.md
+==== ./content/migration-tool.md
+==== ./content/verifying-release-signatures.md
+==== ./content/building.md
+==== ./content/performance-guide.md
+==== ./content/committers.md
+==== ./content/tools.md
+==== ./content/sampletemplate.md
+==== ./README.md
+==== ./migration/README.md
diff --git a/theme/plugins/asfgenid.py b/theme/plugins/asfgenid.py
index eddcb19..1a663f8 100644
--- a/theme/plugins/asfgenid.py
+++ b/theme/plugins/asfgenid.py
@@ -26,26 +26,26 @@ Which is BSD licensed, but is very much rewritten.
'''
ASF_GENID = {
- 'unsafe_tags': 'True', # fix script, style, and iframe html that gfm
filters as unsafe
- 'metadata': True, # {{ metadata }} inclusion of data in the html.
- 'elements': True, # {#id} and {.class} annotations.
- 'headings': True, # add slugified id to headings missing id. Can
be overridden by page metadata.
- 'headings_re': r'^h[1-6]', # regex for which headings to check.
- 'permalinks': True, # add permalinks to elements and
headings when id is added.
- 'toc': True, # check for [TOC] and add Table of Content if
present.
- 'toc_headers': r'h[1-6]', # regex for which headings to include in the
[TOC]
- 'tables': True, # add class="table" for tables missing class.
+ 'unsafe_tags': True, # fix script, style, and iframe html that gfm
filters as unsafe
+ 'metadata': True, # {{ metadata }} inclusion of data in the html.
+ 'elements': True, # {#id} and {.class} annotations.
+ 'headings': True, # add slugified id to headings missing id. Can
be overridden by page metadata.
+ 'headings_re': r'^h[1-6]', # regex for which headings to check.
+ 'permalinks': True, # add permalinks to elements and
headings when id is added.
+ 'toc': True, # check for [TOC] and add Table of Content if
present.
+ 'toc_headers': r'h[1-6]', # regex for which headings to include in the
[TOC]
+ 'tables': True, # add class="table" for tables missing class.
'debug': False
}
# Fixup tuples for HTML that GFM makes into text.
FIXUP_UNSAFE = [
- (re.compile(r'<script'),'<script'),
- (re.compile(r'</script'),'</script'),
- (re.compile(r'<style'),'<style'),
- (re.compile(r'</style'),'</style'),
- (re.compile(r'<iframe'),'<iframe'),
- (re.compile(r'</iframe'),'</iframe')
+ (re.compile(r'<script'), '<script'),
+ (re.compile(r'</script'), '</script'),
+ (re.compile(r'<style'), '<style'),
+ (re.compile(r'</style'), '</style'),
+ (re.compile(r'<iframe'), '<iframe'),
+ (re.compile(r'</iframe'), '</iframe')
]
# Find {{ metadata }} inclusions
@@ -68,6 +68,7 @@ PARA_MAP = {
# Find table tags - to check for ones without class attribute.
TABLE_RE = re.compile(r'^table')
+
# An item in a Table of Contents - from toc.py
class HtmlTreeNode(object):
def __init__(self, parent, header, level, id):
@@ -263,7 +264,7 @@ def generate_toc(content, tags, title, toc_headers):
# convert the HtmlTreeNode into Beautiful Soup
tree_string = '{}'.format(tree)
tree_soup = BeautifulSoup(tree_string, 'html.parser')
- # Make the ToC availble to the theme's template
+ # Make the ToC available to the theme's template
content.toc = tree_soup.decode(formatter='html')
# replace the first [TOC] with the generated table of contents
for tag in tags:
@@ -272,6 +273,22 @@ def generate_toc(content, tags, title, toc_headers):
tree_soup = ''
+# create breadcrumb html
+def make_breadcrumbs(rel_source_path, title):
+ parts = rel_source_path.split('/')
+ url = '/'
+ crumbs = []
+ crumbs.append(f'<a href="/">Home</a> » ')
+ # don't process the filename part
+ last = len(parts)-1
+ for i in range(last):
+ url = f"{url}{parts[i]}/"
+ p = parts[i].capitalize()
+ crumbs.append(f'<a href="{url}">{p}</a> » ')
+ crumbs.append(f'<a href="#">{title}</a>')
+ return ''.join(crumbs)
+
+
# add the asfdata metadata into GFM content.
def add_data(content):
""" Mix in ASF data as metadata """
@@ -303,7 +320,7 @@ def generate_id(content):
ids = set()
# track permalinks
permalinks = set()
-
+
# step 1 - fixup html that cmark marks unsafe - move to later?
if asf_genid['unsafe_tags']:
fixup_content(content)
@@ -314,9 +331,14 @@ def generate_id(content):
# page title
title = content.metadata.get('title', 'Title')
# assure relative source path is in the metadata
- content.metadata['relative_source_path'] = content.relative_source_path
+ content.metadata['relative_source_path'] = rel_source_path =
content.relative_source_path
+ # create breadcrumb html
+ content.metadata['breadcrumbs'] = breadcrumbs =
make_breadcrumbs(rel_source_path, title)
# display output path and title
print(f'{content.relative_source_path} - {title}')
+ # if debug display breadcrumb html
+ if asf_genid['debug']:
+ print(f' {breadcrumbs}')
# enhance metadata if done by asfreader
add_data(content)
@@ -373,7 +395,7 @@ def tb_connect(pel_ob):
"""Print any exception, before Pelican chews it into nothingness."""
try:
generate_id(pel_ob)
- except:
+ except Exception:
print('-----', file=sys.stderr)
print('FATAL: %s' % (pel_ob.relative_source_path), file=sys.stderr)
traceback.print_exc()
