Lucee Docs on Dash?

[Daniel Short]

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

[Dominic Watson]

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)... :)

Dominic

--
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+un...@googlegroups.com.
To post to this group, send email to lu...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/1ded8623-7fea-4e57-b5fc-56efb9ebc100%40googlegroups.com.
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: in...@pixl8.co.uk

Follow us on: Facebook Twitter LinkedIn

CONFIDENTIAL 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

[Dominic Watson]

Here is the issue in JIRA: https://luceeserver.atlassian.net/browse/LD-26

[Daniel Short]

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

Dan

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+un...@googlegroups.com.

To post to this group, send email to lu...@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.

[Dominic Watson]

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

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAHDUjU_gz5EnDNM5zZqGqnZONAE--H2O%2Bvf0iGctNpFcarWe1w%40mail.gmail.com.

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

[michae...@arcor.de]

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 sup...@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.

[Dominic Watson]

I did not realize that Velocity did not support the feed style, that's a shame. I used Zeal when setting up and testing the feed and it works great on my linux laptop - the look and feel isn't stunning, but it gets you to the docs super fast and that's really what matters.

Getting the docs in the official list is an interesting one. The process is not easy to automate, involves forking the Dash repository, adding your docs to a particular directory and commiting them, then submitting a pull request. If anyone is interested in helping out around effecting this then great. For this to work I think we'd need a semi-regular manual process to do this rather than the fully automated system that is currently in place.

Dominic

--

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+un...@googlegroups.com.
To post to this group, send email to lu...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/06c90510-910b-4559-96c0-ee83ecc8cd69%40googlegroups.com.

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