You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@wicket.apache.org by thijs1108 <gi...@git.apache.org> on 2015/06/29 11:22:51 UTC
[GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
GitHub user thijs1108 opened a pull request:
https://github.com/apache/wicket/pull/131
Conversion of Gdoc to Asciidoctor
Used run.sh to convert all Gdoc files to Asciidoctor files. To view the result use ```mvn``` in `wicket-user-guide`
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/thijs1108/wicket asciidoc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/wicket/pull/131.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #131
----
commit 258478b5568033eb0cf4ccdf85afbd4723182957
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-22T13:07:35Z
gdoc converted to adoc
commit a7cdba58825d018d466b8a99ae496b65134c8a1e
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-22T13:27:57Z
created adoc index
commit d51aec2a25303b48131f1e3ad8a10955aaa1b666
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-23T08:43:19Z
links fixed
commit 6e8874c5a17804dc46eef871bacb9504806b7faa
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-23T13:21:27Z
fixed image directory
commit 3e1cc54e262ff7acb9771644ee40a9289526d717
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-23T13:56:24Z
image links
commit ba24f0eb4d9eb0603b3ad7b560d0a97535ea6d48
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-24T08:30:21Z
document links fixed
commit 87935450f7e62e1edfc5b0b49378b7c658b20fbf
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-24T08:56:28Z
added pom.xml
commit 2c150999e057cb34843aa1221afb45f85bdbd565
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-24T09:09:42Z
added good pom.xml
commit b4f89d28b43e2e2fa57a9cd20bb4fd8bb6583739
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-24T13:56:15Z
dependencies
commit 5bbe76c979f57526a0d5263285494e72c0becc94
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-25T11:24:10Z
with pdf output not working
commit 9c65ec2c5049dbf00e6fd99efe6a19988bebd6fc
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-25T13:52:25Z
generate pdf
commit 0c91bf605cbe1f91e7c208cd9ee5cba9a2f1a2b3
Author: Thijs Beltman <th...@topicus.nl>
Date: 2015-06-25T13:58:52Z
cleaned maven
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket issue #131: Conversion of Gdoc to Asciidoctor
Posted by klopfdreh <gi...@git.apache.org>.
Github user klopfdreh commented on the issue:
https://github.com/apache/wicket/pull/131
I think this PR can be closed, now. Thanks a lot for the great new guide!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
Re: [GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by Martin Grigorov <mg...@apache.org>.
Let's merge this to master branch then.
This way we can iron it out before Wicket 8 is released and people start
using it.
It would be good to use it also for 7.x/6.x so that the cherry-picking
still works.
Martin Grigorov
Wicket Training and Consulting
https://twitter.com/mtgrigorov
On Sun, Feb 7, 2016 at 10:17 AM, Martijn Dashorst <
martijn.dashorst@gmail.com> wrote:
> The student who worked on this is returning for additional work at our
> company, so if there are issues he can (and is) willing to help out.
>
> The biggest holdup is that we don't have a multipage HTML generation
> set up with asciidoctor. The format for asciidoctor is great and the
> maintainers work hard to keep it moving forward.
>
> With Maven it is now possible to generate PDF and HTML directly
> without having to install additional software, so that should not be a
> problem anymore.
>
> Martijn
>
>
> On Sat, Feb 6, 2016 at 3:52 PM, martin-g <gi...@git.apache.org> wrote:
> > Github user martin-g commented on the pull request:
> >
> > https://github.com/apache/wicket/pull/131#issuecomment-180781613
> >
> > Do we still have interest in this PR?
> > Anyone wants to merge it (properly) ?
> >
> >
> > ---
> > If your project is set up for it, you can reply to this email and have
> your
> > reply appear on GitHub as well. If your project does not have this
> feature
> > enabled and wishes so, or if the feature is enabled but not working,
> please
> > contact infrastructure at infrastructure@apache.org or file a JIRA
> ticket
> > with INFRA.
> > ---
>
>
>
> --
> Become a Wicket expert, learn from the best: http://wicketinaction.com
>
Re: [GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by Martijn Dashorst <ma...@gmail.com>.
The student who worked on this is returning for additional work at our
company, so if there are issues he can (and is) willing to help out.
The biggest holdup is that we don't have a multipage HTML generation
set up with asciidoctor. The format for asciidoctor is great and the
maintainers work hard to keep it moving forward.
With Maven it is now possible to generate PDF and HTML directly
without having to install additional software, so that should not be a
problem anymore.
Martijn
On Sat, Feb 6, 2016 at 3:52 PM, martin-g <gi...@git.apache.org> wrote:
> Github user martin-g commented on the pull request:
>
> https://github.com/apache/wicket/pull/131#issuecomment-180781613
>
> Do we still have interest in this PR?
> Anyone wants to merge it (properly) ?
>
>
> ---
> If your project is set up for it, you can reply to this email and have your
> reply appear on GitHub as well. If your project does not have this feature
> enabled and wishes so, or if the feature is enabled but not working, please
> contact infrastructure at infrastructure@apache.org or file a JIRA ticket
> with INFRA.
> ---
--
Become a Wicket expert, learn from the best: http://wicketinaction.com
[GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by martin-g <gi...@git.apache.org>.
Github user martin-g commented on the pull request:
https://github.com/apache/wicket/pull/131#issuecomment-180781613
Do we still have interest in this PR?
Anyone wants to merge it (properly) ?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by klopfdreh <gi...@git.apache.org>.
Github user klopfdreh commented on the pull request:
https://github.com/apache/wicket/pull/131#issuecomment-130559921
The first commit is rather big so it is hard to find out - so my question: Is there any documentation about how to setup the php environment to convert gdoc to adoc, or is it simply copy the php files into the root folder of the php server? Thanks for the great work so far! :smiley:
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket issue #131: Conversion of Gdoc to Asciidoctor
Posted by martin-g <gi...@git.apache.org>.
Github user martin-g commented on the issue:
https://github.com/apache/wicket/pull/131
@thijs1108 @dashorst Please close this PR! It has been merged to 8.x and 7.x. Thanks!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by thijs1108 <gi...@git.apache.org>.
Github user thijs1108 commented on the pull request:
https://github.com/apache/wicket/pull/131#issuecomment-131729424
The php scripts can be thrown away after the merge of this commits because then the documentation should be updated in the .adoc files and not in the .gdoc files anymore.
To start converting all the gdoc files to adoc you need to pass all the gdoc files through the `adoccommandline.php`. `run.sh` is doing that, it's searching all the gdoc files in guide/ and convert it to adoc format in asciidoc/. So the first step is run `$ ./run.sh`.
The next step is that there should be one index.adoc file which include all the other adoc files. Gdoc has toc.yml but asciidoc need a completely other syntax. `toctoindex.php` loads guide/toc.yml and give an output that should be index.adoc. To do that, run `$ ./toctoindex.php > asciidoc/index.adoc`.
If that's done, run `$ mvn` in `wicket-user-guide` to render index.adoc to index.html and index.pdf with all adoc files included. In `wicket-user-guide/target/generated-docs` is the result. Ignore the empty directories.
I hope this will help. Thanks for your response!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket pull request #131: Conversion of Gdoc to Asciidoctor
Posted by thijs1108 <gi...@git.apache.org>.
Github user thijs1108 closed the pull request at:
https://github.com/apache/wicket/pull/131
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by dashorst <gi...@git.apache.org>.
Github user dashorst commented on the pull request:
https://github.com/apache/wicket/pull/131#issuecomment-214241704
I still am interested in this. Will take a looksy when I have time.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] wicket pull request: Conversion of Gdoc to Asciidoctor
Posted by martin-g <gi...@git.apache.org>.
Github user martin-g commented on a diff in the pull request:
https://github.com/apache/wicket/pull/131#discussion_r33447991
--- Diff: wicket-user-guide/pom.xml ---
@@ -1,195 +1,357 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You 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.
--->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.wicket</groupId>
- <artifactId>wicket-parent</artifactId>
- <version>7.0.0-SNAPSHOT</version>
- <relativePath>../pom.xml</relativePath>
- </parent>
- <artifactId>wicket-user-guide</artifactId>
- <packaging>jar</packaging>
- <name>Wicket User Guide</name>
- <description>
- Provides the user guide of wicket
- </description>
- <repositories>
- <repository>
- <id>grails</id>
- <name>grails</name>
- <url>http://repo.grails.org/grails/core</url>
- </repository>
- <repository>
- <id>grails-plugins</id>
- <name>grails-plugins</name>
- <url>http://repo.grails.org/grails/plugins</url>
- </repository>
- </repositories>
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.grails</groupId>
- <artifactId>grails-dependencies</artifactId>
- <version>${grails.version}</version>
- <type>pom</type>
- <exclusions>
- <exclusion>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.grails</groupId>
- <artifactId>grails-plugin-log4j</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>org.grails</groupId>
- <artifactId>grails-docs</artifactId>
- <version>${grails.version}</version>
- </dependency>
- </dependencies>
- </dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.grails</groupId>
- <artifactId>grails-dependencies</artifactId>
- <type>pom</type>
- </dependency>
- <dependency>
- <groupId>org.grails</groupId>
- <artifactId>grails-docs</artifactId>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-log4j12</artifactId>
- </dependency>
- </dependencies>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-deploy-plugin</artifactId>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-source-plugin</artifactId>
- </plugin>
- </plugins>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-deploy-plugin</artifactId>
- <configuration>
- <!-- Just documentation. No need to deploy -->
- <skip>true</skip>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <!-- Just documentation, no sources -->
- <skip>true</skip>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-source-plugin</artifactId>
- <configuration>
- <!-- Just documentation, no sources -->
- <skipSource>true</skipSource>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
-
- <profiles>
- <profile>
- <id>guide</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-clean-plugin</artifactId>
- <configuration>
- <filesets>
- <fileset>
- <directory>plugins</directory>
- <includes>
- <include>**/*</include>
- </includes>
- <followSymlinks>false</followSymlinks>
- </fileset>
- </filesets>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.grails</groupId>
- <artifactId>grails-maven-plugin</artifactId>
- <version>${grails.version}</version>
- <extensions>true</extensions>
- <configuration>
- <grailsVersion>${grails.version}</grailsVersion>
- </configuration>
- <executions>
- <!-- HTML guide -->
- <execution>
- <id>doc</id>
- <phase>package</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <command>doc</command>
- </configuration>
- </execution>
- <!-- PDF guide -->
- <execution>
- <id>pdf</id>
- <phase>package</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <command>doc</command>
- <args>--pdf</args>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
- </profiles>
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.asciidoctor.maven</groupId>
+ <artifactId>asciidoc-to-html-example</artifactId>
--- End diff --
Wrong groupId and artifactId
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---