You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-dev@db.apache.org by ti...@apache.org on 2019/11/23 16:55:44 UTC
[db-jdo-site] branch master updated: Added converter
This is an automated email from the ASF dual-hosted git repository.
tilmannz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/db-jdo-site.git
The following commit(s) were added to refs/heads/master by this push:
new 2ec905c Added converter
2ec905c is described below
commit 2ec905c0ca338860dc63e1e49d5876f555738fef
Author: Tilmann <zo...@gmx.de>
AuthorDate: Sat Nov 23 17:55:32 2019 +0100
Added converter
---
LICENSE | 201 ---------------------------------------------
src/main/java/Convert.java | 198 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 198 insertions(+), 201 deletions(-)
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index b09cd78..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,201 +0,0 @@
-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/src/main/java/Convert.java b/src/main/java/Convert.java
new file mode 100644
index 0000000..b9bab10
--- /dev/null
+++ b/src/main/java/Convert.java
@@ -0,0 +1,198 @@
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileReader;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import club.caliope.udc.DocumentConverter;
+import club.caliope.udc.InputFormat;
+import club.caliope.udc.OutputFormat;
+
+
+/**
+ * This class converts the old generated HTML files to ASCIIDOC file.
+ * The paths are hardcoded and assume src and target to have the same base folder.
+ * The html menu can be configured in template/document.html.erb
+ *
+ * To create HTML from the generated ASCIIDOC:
+ * * mvn clean compile
+ * * Copy "target/site"to "docs".
+ *
+ * Link to view html locally in browser:
+ * file:///D:/projects/workspace-zoo/jdo.asciidoc/target/site/
+ *
+ * @author Tilmann Zäschke
+ */
+public class Convert {
+
+ private static final String NL = "\n";
+ // Base folder for src and output files
+ private static final Path basePath = Paths.get("D:\\projects\\workspace-zoo\\jdo.site");
+ // Output folder
+ private static final String output = "pandoc-out";
+
+ public static void main(String[] args) throws IOException {
+ Path srcPath = basePath.resolve("docs");
+
+ String executionPath = System.getProperty("user.dir");
+ System.out.println(executionPath);
+
+ Files.find(srcPath, 10, (p, a) -> { return true; }).forEach(p -> convert(p.toFile()));
+ }
+
+ private static void convert(File src) {
+ if (!src.toString().endsWith(".html")) {
+ // skip non-html: css, ...
+ return;
+ }
+ if (src.toString().contains("docs\\api")) {
+ // skip 'api' folders
+ return;
+ }
+
+ try {
+ String srcName = src.getName();
+ srcName = srcName.substring(0, srcName.lastIndexOf(".") + 1);
+ String dstName = srcName + "adoc";
+
+ Path srcPath = src.toPath();
+ Path relPath = basePath.relativize(srcPath);
+
+ int count = relPath.getNameCount();
+ Path fullOutPath;
+ if (count > 2) {
+ //System.out.println("re2: " + relPath.subpath(1, count-1).toString());
+ fullOutPath = Paths.get(basePath.toString(), output, relPath.subpath(1, count-1).toString(), dstName.toString());
+ } else {
+ fullOutPath = Paths.get(basePath.toString(), output, dstName.toString());
+ }
+
+ if (!fullOutPath.getParent().toFile().exists()) {
+ Files.createDirectories(fullOutPath.getParent());
+ }
+
+ File outFile = Files.createFile(fullOutPath).toFile();
+ new DocumentConverter()
+ .fromFile(src, InputFormat.HTML)
+ .toFile(outFile, OutputFormat.ASCIIDOC)
+ // .addOption("-s") //optional
+ // .workingDirectory(new File("/tmp")) //optional
+ .convert();
+ postConvert(outFile);
+ } catch (IOException e) {
+ e.printStackTrace();
+ throw new RuntimeException(e);
+ }
+ }
+
+ private static void postConvert(File dst) {
+ BufferedReader br;
+ BufferedWriter bw;
+ String s;
+
+ File tempDst = Paths.get(dst.toString() + ".tmp").toFile();
+ dst.renameTo(tempDst);
+ try {
+ bw = new BufferedWriter(new FileWriter(dst, true));
+ try {
+ br = new BufferedReader(new FileReader(tempDst));
+
+ // Write new header
+ bw.write(header());
+
+ // Skip old header
+ while((s = br.readLine()) != null) {
+ if (s.startsWith("[[contentBox]]")) {
+ break;
+ }
+ }
+
+ while((s = br.readLine()) != null) {
+ // System.out.println("Checking: " + s);
+
+ //Lines 1 and 2:
+ // TODO ? Replace Images:
+ //link:./[image:images/JDOx150.gif[Apache JDO]]
+ //link:./[image:images/jdo_text.gif[Apache JDO]]
+ //image:images/JDOx150.gif[Apache JDO]
+ //image:images/jdo_text.gif[Apache JDO]
+
+ // Fix external links
+ s = s.replace(".html", ".adoc");
+ // Fix internal crossrefs
+ s = s.replace("link:#", "xref:");
+
+ // Fix GIF not supported:
+ s = s.replace(".gif", ".png");
+
+ // Fix empty lines
+ // see https://github.com/asciidoctor/asciidoctor/wiki/How-to-insert-sequential-blank-lines
+ if (s.equals(" +")) {
+ s = "{empty} +\n";
+ bw.write(s + NL);
+ continue;
+ }
+
+ // Fix crossref targets/anchors
+ // INPUT:
+ //[#PersistenceCapable]##
+ //==== @PersistenceCapable[#aPersistenceCapable]####
+ // OUPUT:
+ //anchor:anchor-2[]
+ while (s.contains("[#")) {
+ int pos1 = s.indexOf("[#");
+ int pos2 = s.indexOf("]", pos1+1);
+ String post = "[" + s.substring(pos2);
+ if (pos1 > 0) {
+ s = s.substring(0, pos1) + "anchor:" + s.substring(pos1+2, pos2) + post;
+ } else {
+ s = "anchor:" + s.substring(2, pos2) + post;
+ }
+ }
+
+ // some more hacks:
+ s = s.endsWith("]##") ? s.substring(0, s.lastIndexOf(']') + 1) : s;
+ s = s.endsWith("]####") ? s.substring(0, s.lastIndexOf(']') + 1) : s;
+
+ bw.write(s + NL);
+ }
+ br.close();
+ } catch(FileNotFoundException e) {
+ System.out.println("File was not found!");
+ } catch(IOException e) {
+ System.out.println("No file found!");
+ }
+ bw.close();
+ } catch(FileNotFoundException e) {
+ System.out.println("Error1!");
+ } catch(IOException e) {
+ System.out.println("Error2!");
+ }
+ tempDst.delete();
+ }
+
+ private static String header() {
+ StringBuilder s = new StringBuilder();
+ s.append("[[index]]").append(NL);
+ s.append("image::images/JDOx150.png[align=\"center\"]").append(NL);
+ s.append("image::images/jdo_text.png[align=\"center\"]").append(NL);
+ s.append("== JDO TEST").append(NL);
+ //s.append("link:./[image:images/JDOx150.gif[Apache JDO]]").append(NL);
+ //s.append("link:./[image:images/jdo_text.gif[Apache JDO]]").append(NL);
+ s.append(NL);
+ s.append("'''''").append(NL);
+ s.append(NL);
+ s.append(":_basedir: ").append(NL);
+ s.append(":_imagesdir: images/").append(NL);
+ s.append(":notoc:").append(NL);
+ s.append(":titlepage:").append(NL);
+ s.append(":grid: cols").append(NL);
+ s.append(NL);
+ return s.toString();
+ }
+}