[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=all ] Max Andersen updated JBIDE-1703: -------------------------------- Attachment: pom.xml -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12397305 ] Max Andersen commented on JBIDE-1703: ------------------------------------- info from Mark Newton on these files: I've now uploaded the two Maven plugins that I created (jbossorg-docbook-xslt and jbossorg-jdocbook-style) to our remote repository so you don't have to build them locally. The only steps you have to take now are as follows: 1) Make sure that you have a ~/.m2/settings.xml file like the one attached to this email. This is needed to add the jboss release and snapshot repositories to your maven configuration. If you already have a settings.xml file then you just need to add the jboss.repository profile. 2) You need to have a pom.xml for the documentation that you're trying to generate. This will typically reside in the same directory as the build.xml file you used to use, e.g. http://anonsvn.jboss.org/repos/jbosstools/trunk/documentation/guides/user... I've attached the pom.xml that I used for the above example to generate docs for the JBoss Tools Getting Started Guide. If you copy this pom.xml and use it for other projects then you need to alter the following xml elements: <artifactId> <configuration> <sourceDocumentName> <sourceDirectory> <imageResource> <directory> <includes> <include> You should get the idea once you look at it. It's pretty self explanatory :) That's all you should need to do. Maven will download all the dependencies and produce 4 formats (assuming you don't comment any of the <format> elements out in the pom.xml): HTML Single-page HTML Eclipse Help (HTML with toc.xml and plugin.xml - you might need to alter the contents of the plugin.xml by hand still) PDF The HTML is actually strict XHTML so it is very consistent :) -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12397320 ] Max Andersen commented on JBIDE-1703: ------------------------------------- Questions: 1) old ant based have syntax highlighting for java, xml, etc. source - any way we can add that into the docbook setup ? (see example at http://www.redhat.com/developer_studio/guides/GettingStartedGuide/html_si...) 2) Anyway to choose which format to generate on the commandline ? (e..g only generate single html to speed up turnaround) 3) why is the individual page html chopped up in that many pieces ? is that usable compared to have 1 page per html. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12398200 ] Svetlana mukhina commented on JBIDE-1703: ----------------------------------------- Things that I don't like in new HTML versions: 1. no collapsing "+" sings on TOC, they are very convenient and useful, plz have a look at this script - https://svn.jboss.org/repos/jbosstools/trunk/jsf/docs/resources/styles/en... 2. no code highlighting, and I don't like the bright yellow background for the code. 3. no meaningful words highlighting (paths, words, etc.) , font styles are saved (bold and italic), but no blue highlighting for tag "property" 4. Note box is too dark, why to leave as it was, a slightly-yellow background; also I don't like that background color for all boxes is the same, we have pale-yellow to note, pale-blue for tip, pale-red for important. 5. html version requires the following parameters in main-html.xsl andnochunk-html.xsl: <!-- Ignore image scaling in html version --> <xsl:param name="ignore.image.scaling" select="1"/> this is necessary, because in PDF we define scale for image to avoid big images corruption, but in html we need to ignore the scale param, as in html images are showed correctly and if this param is defined the image become smaller then necessary. 6.text alignment. better to make "justify", so the edges look neatly 7. grey bullets for list items are hardly seen some of this things we could fix by ourselves, the question is whether we are allowed or should use the exact template of RH. also we could make different skin for a guide, its quite easy. thus, let's discuss these points? -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12398219 ] Svetlana mukhina commented on JBIDE-1703: ----------------------------------------- 1. when a TOC isn't collapsed you could have never-ending menu items sequence, I don't like it, and I'm for TOC collapsing. 2. ok 3. <emphasis> is used for a font type definition, but it doesn't highlight words in color, but word highlighting is required for better understanding and usability. 4. will ask Samson 5. but we can't do it ourselves as we don't have sources 6. in guide now text is left-aligned, thus right edge is ragged, just compare left and right text edges. 7. will ask Samson ok -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=all ] Anatoly Fedosik updated JBIDE-1703: ----------------------------------- Attachment: eclipse.xsl -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12398309 ] Anatoly Fedosik commented on JBIDE-1703: ---------------------------------------- one more subject for discussion: in multiple pages version we see *one* section on the page, before we had one *chapter* on the page. Probably it is not very well when we have one sentence in the section. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12399143 ] Mark Newton commented on JBIDE-1703: ------------------------------------ I've migrated the build system for JBoss Tools documentation from the old Ant based system to the new Maven2 based system. This means that the XSLT files previously found in resources/styles/en/*.xsl are now contained in a maven plugin called jbosstools-docbook-xslt. Similarly the CSS, images, and JavaScript files are now contained in a maven plugin called jbosstools-jdocbook-style. The source for these plugins can be found here: https://svn.jboss.org/repos/jbosstools/trunk/documentation/jbosstools-doc... https://svn.jboss.org/repos/jbosstools/trunk/documentation/jbosstools-jdo... The DocBook libraries, DTD and XSLT files that previously lived in resources/support are now contained in maven plugin called docbook which is referenced as a dependency from the jbosstools maven plugins. Each project that wishes to use the new maven based build system must include a pom.xml similar to the ones already created here: https://svn.jboss.org/repos/jbosstools/trunk/documentation/guides/usergui... https://svn.jboss.org/repos/jbosstools/trunk/documentation/guides/usergui... https://svn.jboss.org/repos/jbosstools/trunk/documentation/guides/usergui... These pom.xml files are very small as I've removed all of the duplicated information, as requested by Max, to a parent pom that is referenced. You can see the contents of this parent pom.xml here: https://svn.jboss.org/repos/jbosstools/trunk/documentation/jbosstools-doc... It depends on the jhighlight-1.0.jar and java2html.jar libraries that were previously contained in resources/support/lib using normal Maven dependencies. It also depends on the highlight.jar library which currently lives inside a local Maven repository on my machine as I need permission from the authors (Exadel) to publish it in our public repository at: http://repository.jboss.org/maven2 All the other maven plugins mentioned above are already published in this public repository so once this final highlight.jar is published everything will work fine. In the meantime if you want to install highlight.jar into your local repository to try out the new Maven based build you need to enter the following command from the directory where it is located on your local disk: mvn install:install-file -Dfile=highlight.jar -DgroupId=com.exadel.docbook.colorer -DartifactId=highlight -Dversion=1.0 -Dpackaging=jar Now that we fetch all of the build elements (DocBook 1.72, custom XSLT, common CSS, images, JavaScript and Highlighting libraries) using Maven you should be able to remove all of the following duplicated resources/ directories: JBoss Tools 2.0.0.GA Documentation --------------------------------------------------- Seam Dev Tools Reference Guide - https://svn.jboss.org/repos/jbosstools/trunk/seam/docs/resources/ Visual Web Tools Reference Guide - https://svn.jboss.org/repos/jbosstools/trunk/jsf/docs/resources/ JBoss Server Manager Reference Guide - https://svn.jboss.org/repos/jbosstools/trunk/as/docs/resources/ jBPM Tools Reference Guide - https://svn.jboss.org/repos/jbosstools/trunk/jbpm/docs/resources/ Hibernate Tools Reference Guide - https://svn.jboss.org/repos/jbosstools/trunk/hibernatetools/docs/resources/ Legacy-jsf-struts guide - https://svn.jboss.org/repos/jbosstools/trunk/documentation/guides/resources/ Other locations --------------------- documentation/development - https://svn.jboss.org/repos/jbosstools/trunk/documentation/development/re... If you want to merge the XSLT and CSS/images used by the default JBoss.org Look & Feel plugins with the JBoss Tools ones (to resolve some of the issues mentioned in the above comments) then the source is located here: http://anonsvn.jboss.org/repos/labs/labs/jbosslabs/trunk/doc/jbossorg-doc... http://anonsvn.jboss.org/repos/labs/labs/jbosslabs/trunk/doc/jbossorg-jdo... -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12399146 ] Mark Newton commented on JBIDE-1703: ------------------------------------ Anatoly, the main-eclipse.xsl file used to produce Eclipse help for the default JBoss.org L&F produces plugin.xml and toc.xml files fine on my machine. I've taken a look at the eclipse.xsl file that you attached and have included it into the Maven2 plugin so that all projects can benefit. However, I don't understand why you're basing your customisations on the html XSL files from the DocBook distribution: <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.72.0/html/chunk.x... If you used the eclipse XSL files (as done in main-eclipse.xsl) then you wouldn't have to explicitly created the toc.xml and plugin.xml files yourself: <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.72.0/eclipse/ecli... <!-- We need to override the imported html/chunk.xsl from eclipse/eclipse.xsl to generate valid XHTML --> <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.72.0/xhtml/chunk.... -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12399234 ] Svetlana mukhina commented on JBIDE-1703: ----------------------------------------- "...It also depends on the highlight.jar library which currently lives inside a local Maven repository on my machine as I need permission from the authors (Exadel) to publish it in our public repository at:" All this highlighter is already open-source and distributed with Richfaces, it is of LGPL, so you could put it on http://repository.jboss.org/maven2 -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12399350 ] Svetlana mukhina commented on JBIDE-1703: ----------------------------------------- and also there is a question about RichFaces project, that is already on uses maven, should its styles also be changed? -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12399732 ] Mark Newton commented on JBIDE-1703: ------------------------------------ Hi Anatoly, The parent POM is already published in the JBoss public maven repository inside its own plugin: http://repository.jboss.org/maven2/org/jboss/tools/documentation/ The only reason that I included the other URL is because that's where the source for this plugin is located: https://svn.jboss.org/repos/jbosstools/trunk/documentation/jbosstools-doc... The pom.xml file located at https://svn.jboss.org/repos/jbosstools/trunk/documentation/guides/usergui... references the parent POM using the following XML element: <parent> <groupId>org.jboss.tools</groupId> <artifactId>documentation</artifactId> <version>1.0</version> </parent> This causes Maven to download the parent POM into your local repository where it is then referenced. So the pom.xml file that you've created for the Seam guide should just use the same mechanism, i.e. include the above <parent> XML element. The comments you included from the parent pom.xml file relate to publishing the POM into the JBoss public maven repository. Basically we can't use the normal 'mvn deploy' command because we don't have SVN set up to accept uploads over HTTP. Therefore we check out the repository contents from SVN into a local working copy and then set a property ${maven.repository.root} to point to this in the local filesystem. The 'mvn deploy' command then causes the plugin to be published to the local working copy of the repository and we then perform an 'svn commit' manually. Hope this clears things up for you :) Mark -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12399896 ] Svetlana mukhina commented on JBIDE-1703: ----------------------------------------- thus, as I understand the guides that are done for studio and with studio screens (GSG, migration, visual web tools, legacy) get Enterprise stylesheet i.e. the stylesheet that they already have, but the reference guides for JbossTools will get jboss.org styles. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12400147 ] Mark Newton commented on JBIDE-1703: ------------------------------------ Svetlana, I recently released a new user guide explaining the updated JBoss DocBook system based on Maven: http://docs.jboss.org/docbook/userguide/html/ http://docs.jboss.org/docbook/userguide/html_single/ http://docs.jboss.org/docbook/userguide/pdf/ As a result all JBoss.org projects can now use the default JBoss.org community driven look & feel to style their docs. We still need to think about merging the best bits of the JBoss.org default style and your Exadel style as discussed earlier in this thread. We also need to think about possibly merging the JBoss Enterprise style with the Exadel style for the same reasons. Do you guys have a weekly meeting that I could drop in on please? This may make it easier to discuss these issues and find a way forward. thanks, Mark -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12403334 ] Gleb Galkin commented on JBIDE-1703: ------------------------------------ I' ve discovered how to make a bundle of all jboss-tools docs: I've added a pom.xml and all_guides.xml into jboss-tools-docs folder (see in svn). But I've some problems: 1. with ant task: I try to delete 'archive-tmp' folder from target folder, but it doesn't work. The code is: <plugin> <artifactId>maven-antrun-plugin</artifactId> <executions> <execution> <phase>package</phase> <configuration> <tasks> <echo message="################### Deleting archive-tmp #####################"/> <delete includeEmptyDirs="true" dir="target/archive-tmp"/> </tasks> </configuration> <goals> <goal>run</goal> </goals> </execution> </executions> </plugin> 2. <ignoreDirFormatExtensions>true</ignoreDirFormatExtensions> parameter doesn't work. So the 'finalName' appers with suffix '.dir' (en.dir) -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=all ] Max Andersen resolved JBIDE-1703. --------------------------------- Resolution: Done I consider this one resolved - let me know if that is wrong ;) -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=all ] Anatoly Fedosik updated JBIDE-1703: ----------------------------------- Attachment: frontPage.png -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12408866 ] Max Rydahl Andersen commented on JBIDE-1703: -------------------------------------------- anatoly - why not create a seperate issue for this ? the docs are building with maven. This you are talking about is a new issue ;) -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira