Skip to content

Conversation

@mojavelinux
Copy link
Contributor

Summary of changes:

  • Reworked the convert.sh script to allow the formats to be specified (defaults to html,docbook,fopdf)
  • Configured image paths so previews work when viewing / rendering an individual chapter
  • Put the UI macros to use (keybinding, button and menu) (requires setting the experimental attribute)
  • Demo the use of open block as a content container (like a div) to simplify lists with complex content
  • Remove unnecessary option="header" attribute on tables (Asciidoctor works it out by convention)
  • Configure syntax highlighting
  • Additional minor cleanups, grammar and spelling corrections

Best practices regarding images:

  • You should not hardcode the path to the image. Instead, the image path should be relative to the "image catalog", which can be configured on a per-document or per-build basis.
  • Titles for block (standalone) images should be specified above the macro

- set imagesdir per document
- remove hardcoded path to images in image macros
- override imagesdir in convert script
- use proper inline image syntax
- update convert script to accept list of formats
- set doctype to book in document
- also correctly label OSX (Mac is not the proper term)
- additionally, put title above image instead of as attribute
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The imagesdir assignment is necessary for previewing the document on GitHub or when rendering the chapter individually. This value is overridden by the convert.sh script.

arun-gupta added a commit that referenced this pull request Jan 29, 2014
Numerous configuration and syntax enhancements
@arun-gupta arun-gupta merged commit d9f153b into javaee-samples:master Jan 29, 2014
@arun-gupta
Copy link
Contributor

This is really a great pull request and cleans up asciidoc and much better rendering.

Can we have the headers in a single line instead of spanning multiple ?

@mojavelinux mojavelinux deleted the image-paths-and-enhancements branch January 29, 2014 11:54
@mojavelinux
Copy link
Contributor Author

Thanks Arun! Hopefully you can pick up on some of the suggestions and apply them throughout the lab. When I have more time I'd be glad to continue to refine the syntax as well.

To which headers are you referring?

@arun-gupta
Copy link
Contributor

Yes, I'll apply the suggestions through out the lab and hopefully be able to author better asciidoc documents.

Page headers ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants