Lucee Docs on Dash?

dev google-group-archive
1

Has there been any progress on getting the Lucee docs in a format available
in Dash? Would love to see some Lucee help in Sublime. I know there was a
brief discussion of this back in February, but I’m not sure there was a
solid resolution.

Thanks,

Dan

2

There’s certainly no working solution as yet - though an issue has been
raised. If you’re keen to help out, can show you how to create custom
builds of the docs (the dash docs could be a first alternative build)… :slight_smile:

DominicOn 14 May 2015 at 16:01, Daniel Short <@Daniel_Short> wrote:

Has there been any progress on getting the Lucee docs in a format
available in Dash? Would love to see some Lucee help in Sublime. I know
there was a brief discussion of this back in February, but I’m not sure
there was a solid resolution.

Thanks,

Dan

–
You received this message because you are subscribed to the Google Groups
“Lucee” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com
https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com?utm_medium=email&utm_source=footer
.
For more options, visit https://groups.google.com/d/optout.

–
Pixl8 Interactive, 3 Tun Yard, Peardon Street, London
SW8 3HT, United Kingdom

T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: info@pixl8.co.uk
Follow us on: Facebook http://www.facebook.com/pixl8 Twitter
http://www.twitter.com/pixl8 LinkedIn
http://www.linkedin.com/pixl8CONFIDENTIAL
AND PRIVILEGED - This e-mail and any attachment is intended solely for the
addressee, is strictly confidential and may also be subject to legal,
professional or other privilege or may be protected by work product
immunity or other legal rules. If you are not the addressee please do not
read, print, re-transmit, store or act in reliance on it or any
attachments. Instead, please email it back to the sender and then
immediately permanently delete it. Pixl8 Interactive Ltd Registered in
England. Registered number: 04336501. Registered office: 8 Spur Road,
Cosham, Portsmouth, Hampshire, PO6 3EB

3

A quick tour of how to build a new doc format would be awesome.

DanOn Sat, May 16, 2015 at 2:09 AM Dominic Watson <@Dominic_Watson> wrote:

Here is the issue in JIRA: [LD-26] - Lucee

On 16 May 2015 at 07:44, Dominic Watson <@Dominic_Watson> wrote:

There’s certainly no working solution as yet - though an issue has been
raised. If you’re keen to help out, can show you how to create custom
builds of the docs (the dash docs could be a first alternative build)… :slight_smile:

Dominic

On 14 May 2015 at 16:01, Daniel Short <@Daniel_Short> wrote:

Has there been any progress on getting the Lucee docs in a format
available in Dash? Would love to see some Lucee help in Sublime. I know
there was a brief discussion of this back in February, but I’m not sure
there was a solid resolution.

Thanks,

Dan

–
You received this message because you are subscribed to the Google
Groups “Lucee” group.
To unsubscribe from this group and stop receiving emails from it, send
an email to lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com
https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com?utm_medium=email&utm_source=footer
.
For more options, visit https://groups.google.com/d/optout.

–
Pixl8 Interactive, 3 Tun Yard, Peardon Street, London
SW8 3HT, United Kingdom

T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: info@pixl8.co.uk
Follow us on: Facebook http://www.facebook.com/pixl8 Twitter
http://www.twitter.com/pixl8 LinkedIn http://www.linkedin.com/pixl8CONFIDENTIAL
AND PRIVILEGED - This e-mail and any attachment is intended solely for the
addressee, is strictly confidential and may also be subject to legal,
professional or other privilege or may be protected by work product
immunity or other legal rules. If you are not the addressee please do not
read, print, re-transmit, store or act in reliance on it or any
attachments. Instead, please email it back to the sender and then
immediately permanently delete it. Pixl8 Interactive Ltd Registered in
England. Registered number: 04336501. Registered office: 8 Spur Road,
Cosham, Portsmouth, Hampshire, PO6 3EB

–
Pixl8 Interactive, 3 Tun Yard, Peardon Street, London
SW8 3HT, United Kingdom

T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: info@pixl8.co.uk
Follow us on: Facebook http://www.facebook.com/pixl8 Twitter
http://www.twitter.com/pixl8 LinkedIn http://www.linkedin.com/pixl8CONFIDENTIAL
AND PRIVILEGED - This e-mail and any attachment is intended solely for the
addressee, is strictly confidential and may also be subject to legal,
professional or other privilege or may be protected by work product
immunity or other legal rules. If you are not the addressee please do not
read, print, re-transmit, store or act in reliance on it or any
attachments. Instead, please email it back to the sender and then
immediately permanently delete it. Pixl8 Interactive Ltd Registered in
England. Registered number: 04336501. Registered office: 8 Spur Road,
Cosham, Portsmouth, Hampshire, PO6 3EB

–
You received this message because you are subscribed to a topic in the
Google Groups “Lucee” group.
To unsubscribe from this topic, visit
https://groups.google.com/d/topic/lucee/d2hYZNvfx4c/unsubscribe.
To unsubscribe from this group and all its topics, send an email to
lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/CAEYvUx%3DwiyD4mKXnrkBKAFc263rWA-ZpO%3Dm711Ls-855kZvOxQ%40mail.gmail.com
https://groups.google.com/d/msgid/lucee/CAEYvUx%3DwiyD4mKXnrkBKAFc263rWA-ZpO%3Dm711Ls-855kZvOxQ%40mail.gmail.com?utm_medium=email&utm_source=footer
.
For more options, visit https://groups.google.com/d/optout.

4

The super quick version (we’ll need to get this in the ‘about the docs’
guide at some point):

  • Beneath the /builders folder is a folder per builder. Right now, there is
    only an html builder. For dash, we would add a ‘dash’ folder and so on.
  • Each builder folder is required to have a Builder.cfc file that
    implements two public methods (see below)

So for Dash, we would have:

/lucee-docs
→ /builders
→ -> /dash
→ -> → Builder.cfc

The /builders/html/Builder.cfc file should provide a pretty good base
reference from which to copy. Below is a little more detail though:

Required methods for Builder.cfc-------------------------------------------------

public void function build( docTree, buildDirectory ){…}

This will be called once to build the documentation. It is up to the build
method to do whatever it takes to build the output in its target format.

  • docTree is a api.data.DocTree object. docTree.getTree() will return an
    array of page objects. Each page object has a method ‘getChildren()’ that
    will return an array of page objects (if it has any children)
  • buildDirectory is the directory that the build system want your builder
    to output its artefacts

public string function renderLink( page, title ){…}

  • page - object representing the page to link to
  • title - text for the link

Helper methods available to Builder.cfc

renderTemplate( string template, struct args )

  • Template path is relative to the Builder.cfc file
  • args will be available to the .cfm file

Helper methods available to templates rendered with renderTemplate()

markdownToHtml( markdown )

Dominic

On 17 May 2015 at 02:44, Daniel Short <@Daniel_Short1> wrote:

A quick tour of how to build a new doc format would be awesome.

Dan
On Sat, May 16, 2015 at 2:09 AM Dominic Watson <@Dominic_Watson> wrote:

Here is the issue in JIRA: [LD-26] - Lucee

On 16 May 2015 at 07:44, Dominic Watson <@Dominic_Watson> wrote:

There’s certainly no working solution as yet - though an issue has been
raised. If you’re keen to help out, can show you how to create custom
builds of the docs (the dash docs could be a first alternative build)… :slight_smile:

Dominic

On 14 May 2015 at 16:01, Daniel Short <@Daniel_Short> wrote:

Has there been any progress on getting the Lucee docs in a format
available in Dash? Would love to see some Lucee help in Sublime. I know
there was a brief discussion of this back in February, but I’m not sure
there was a solid resolution.

Thanks,

Dan

–
You received this message because you are subscribed to the Google
Groups “Lucee” group.
To unsubscribe from this group and stop receiving emails from it, send
an email to lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com
https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com?utm_medium=email&utm_source=footer
.
For more options, visit https://groups.google.com/d/optout.

–
Pixl8 Interactive, 3 Tun Yard, Peardon Street, London
SW8 3HT, United Kingdom

T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: info@pixl8.co.uk
Follow us on: Facebook http://www.facebook.com/pixl8 Twitter
http://www.twitter.com/pixl8 LinkedIn http://www.linkedin.com/pixl8CONFIDENTIAL
AND PRIVILEGED - This e-mail and any attachment is intended solely for the
addressee, is strictly confidential and may also be subject to legal,
professional or other privilege or may be protected by work product
immunity or other legal rules. If you are not the addressee please do not
read, print, re-transmit, store or act in reliance on it or any
attachments. Instead, please email it back to the sender and then
immediately permanently delete it. Pixl8 Interactive Ltd Registered in
England. Registered number: 04336501. Registered office: 8 Spur Road,
Cosham, Portsmouth, Hampshire, PO6 3EB

–
Pixl8 Interactive, 3 Tun Yard, Peardon Street, London
SW8 3HT, United Kingdom

T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: info@pixl8.co.uk
Follow us on: Facebook http://www.facebook.com/pixl8 Twitter
http://www.twitter.com/pixl8 LinkedIn http://www.linkedin.com/pixl8CONFIDENTIAL
AND PRIVILEGED - This e-mail and any attachment is intended solely for the
addressee, is strictly confidential and may also be subject to legal,
professional or other privilege or may be protected by work product
immunity or other legal rules. If you are not the addressee please do not
read, print, re-transmit, store or act in reliance on it or any
attachments. Instead, please email it back to the sender and then
immediately permanently delete it. Pixl8 Interactive Ltd Registered in
England. Registered number: 04336501. Registered office: 8 Spur Road,
Cosham, Portsmouth, Hampshire, PO6 3EB

–
You received this message because you are subscribed to a topic in the
Google Groups “Lucee” group.
To unsubscribe from this topic, visit
https://groups.google.com/d/topic/lucee/d2hYZNvfx4c/unsubscribe.
To unsubscribe from this group and all its topics, send an email to
lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/CAEYvUx%3DwiyD4mKXnrkBKAFc263rWA-ZpO%3Dm711Ls-855kZvOxQ%40mail.gmail.com
https://groups.google.com/d/msgid/lucee/CAEYvUx%3DwiyD4mKXnrkBKAFc263rWA-ZpO%3Dm711Ls-855kZvOxQ%40mail.gmail.com?utm_medium=email&utm_source=footer
.
For more options, visit https://groups.google.com/d/optout.

–
You received this message because you are subscribed to the Google Groups
“Lucee” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/CAHDUjU_gz5EnDNM5zZqGqnZONAE--H2O%2Bvf0iGctNpFcarWe1w%40mail.gmail.com
https://groups.google.com/d/msgid/lucee/CAHDUjU_gz5EnDNM5zZqGqnZONAE--H2O%2Bvf0iGctNpFcarWe1w%40mail.gmail.com?utm_medium=email&utm_source=footer
.

For more options, visit https://groups.google.com/d/optout.

–
Pixl8 Interactive, 3 Tun Yard, Peardon Street, London
SW8 3HT, United Kingdom

T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: info@pixl8.co.uk
Follow us on: Facebook http://www.facebook.com/pixl8 Twitter
http://www.twitter.com/pixl8 LinkedIn
http://www.linkedin.com/pixl8CONFIDENTIAL
AND PRIVILEGED - This e-mail and any attachment is intended solely for the
addressee, is strictly confidential and may also be subject to legal,
professional or other privilege or may be protected by work product
immunity or other legal rules. If you are not the addressee please do not
read, print, re-transmit, store or act in reliance on it or any
attachments. Instead, please email it back to the sender and then
immediately permanently delete it. Pixl8 Interactive Ltd Registered in
England. Registered number: 04336501. Registered office: 8 Spur Road,
Cosham, Portsmouth, Hampshire, PO6 3EB

5

Quick general update based on personal experience:

To officially add the docset to the standard list in Dash and its Windows
counterpart Velocity it’s necessary to “vote” for it by contacting
support@kapeli.com (kinda makes sense if they want to avoid clutter).
While Velocity doesn’t have direct support for feeds like the one mentioned
at http://docs.lucee.org/download.html the next best Windows alternative is
Zeal (http://zealdocs.org/), which while it doesn’t look as nice as the
other two, is free, open source, available for Windows & Linux and adding
the feed is just a matter of two mouse clicks.