Luceedocs.com

Hi everyone,

I made a start of setting up a docs website for Lucee with the help from
readme.io.
They supported by giving me a free license and are looking into cfml code
colouring support so we can show cfml code examples.

Over the coming days I’ll be adding docs for tags and functions and was
hoping 1 or 2 list members could help me with writing examples.

You can find it on luceedocs.com

Let me know what you guys think and if you have any pointers, let me know
(or provide enhancements on the luceedocs.com site.

Regards,–
Michael van Leest

What do people think about showing tags around script examples?
I personally prefer script examples not to have tags arund them.

Michael,

Seems like a good start to me, especially in that it is a platform designed
for documentation. The only thing I’m concerned about is that we don’t
duplicate the effort.

An interesting bit I see in the FAQ: if you document your API right in
your code, you can import it from GitHub! We’ll create stubs from the code,
and you can edit the rest on the site.

And

ReadMe was built almost entirely on Open Source projects, so we want to
give back. If you’re an open source project, shoot us an email and we’ll
upgrade you to the Developer Hub tier for free. It’s the least we can do to
give back.

Aria Media Sagl
Via Rompada 40
6987 Caslano
Switzerland

+41 (0)91 600 9601
+41 (0)76 303 4477 cell
skype: ariamediaOn Fri, Feb 20, 2015 at 10:25 AM, Michael van Leest <@Michael_van_Leest> wrote:

Hi everyone,

I made a start of setting up a docs website for Lucee with the help from
readme.io.
They supported by giving me a free license and are looking into cfml code
colouring support so we can show cfml code examples.

Over the coming days I’ll be adding docs for tags and functions and was
hoping 1 or 2 list members could help me with writing examples.

You can find it on luceedocs.com

Let me know what you guys think and if you have any pointers, let me know
(or provide enhancements on the luceedocs.com site.

Regards,


Michael van Leest


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/CAMaJE6tpcvh4atS8yL4hhQy37pmUj5EDztqjBk0KjNGrkAtwEA%40mail.gmail.com
https://groups.google.com/d/msgid/lucee/CAMaJE6tpcvh4atS8yL4hhQy37pmUj5EDztqjBk0KjNGrkAtwEA%40mail.gmail.com?utm_medium=email&utm_source=footer
.
For more options, visit https://groups.google.com/d/optout.

Add a ticket pls. Probably need to create a new Disqus for Luceedocs.

Mark Drew> On 20 Feb 2015, at 18:43, Sean Corfield <@Sean_Corfield> wrote:

Cool! Love that the search brings up all the member functions too!

The “Download >>” link on the home page goes to http://www.downloads.html

Disqus isn’t loading on the individual function / tag pages - known issue?

On Feb 20, 2015, at 10:21 AM, Mark Drew <@Mark_Drew> wrote:
I have merged your changes and worked on an exporter, which I now need to add ejs template files to generate the output

You can see the app running on: http://luceedocs.herokuapp.com/

(in a while http://www.luceedocs.org should point there)


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/wsuvmNOxnz0/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/52C66E4E-E3CE-4ABA-A104-F1D2CD260EAE%40corfield.org.
For more options, visit https://groups.google.com/d/optout.

@Mark: I was already looking at railodocs. I’ve used a similar approach.

http://www.luceedocs.com/v4.5/docs/cfabort2015-02-20 15:15 GMT+01:00 Mark Drew <@Mark_Drew>:

@Nando: I’ve approved the edit just as example.

I need to create some sort of basic template so it’s easier to add new
stuff and keep the same layout. I will begin with tags and create the full
documentation of cfabort as an example.

Like the ones from Railodocs?

http://www.railodocs.org/tag/cfcache

I have the ejb templates for functions and tags too.

It says it can take stuff from a repo and show it. Sounds like
readthedocs.org?

MD


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/16B81CA3-A49C-4D9A-A98D-677AEE815FD3%40gmail.com
https://groups.google.com/d/msgid/lucee/16B81CA3-A49C-4D9A-A98D-677AEE815FD3%40gmail.com?utm_medium=email&utm_source=footer
.

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


Michael van Leest

Nando,

the tag and function reference text comes from

https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/tld/web-cfmtaglibrary_1_0
and
https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/fld/web-cfmfunctionlibrary_1_0

If you find errors or typos you can update those files and submit a patch.

remember that they are xml files so any changes must be xml compliant.

thanks,

Igal Sapir
Lucee Core Developer
Lucee.org http://lucee.org/On 2/20/2015 1:49 PM, Mark Drew wrote:

What the project does is make a bunch of JSON files that are the data
files that drive the site (tags, functions, objects) from a lucee
server using the following script (no black magic)

https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm

It then generates a folder that you can check out here:

https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json

So you can (at the moment) just send pull requests with changes to
each of these files (for the develop branch) and we can then display
them in the site when it gets merged into master.

Following up from my email of a while ago, I need to have a way to
show content, so I might integrate that into the md files from the
wiki or something.

Or just put them in there as there are plenty of markdown -> html
solutions out there. I shall add a ticket

Mark Drew

develop • deploy • deliver
http://charliemikedelta.com ttp://charliemikedelta.com

On 20 Feb 2015, at 21:45, Nando Breiter <@Nando_Breiter mailto:Nando_Breiter> wrote:

Mark, this looks fantastic. Thanks!

Do I understand it correctly that the content itself is in the Lucee
source code? Where should we submit tickets for typo’s and
grammatical mistakes? Or maybe a better question might be, how do we
maintain and contribute to the documentation as a community without
it needing to all go through Micha and Igal (if the content is within
the Lucee source).

Aria Media Sagl
Via Rompada 40
6987 Caslano
Switzerland

+41 (0)91 600 9601
+41 (0)76 303 4477 cell
skype: ariamedia

On Fri, Feb 20, 2015 at 10:22 PM, Mark Drew <@Mark_Drew mailto:Mark_Drew> wrote:

Cheers for that! I shall get to them next week (house painting
this weekend!)
Having said that, there are already pull requests!

Mark Drew

> On 20 Feb 2015, at 19:15, Sean Corfield <@Sean_Corfield <mailto:@Sean_Corfield>> wrote:
>
> Thank you! I created a bunch of issues for minor bugs /
suggestions.
>
> Sean
>
>> On Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew <mailto:@Mark_Drew>> wrote:
>> Here you go sah!
>>
>> https://github.com/cybersonic/luceedocs
>
> --
> 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/wsuvmNOxnz0/unsubscribe.
> To unsubscribe from this group and all its topics, send an
email to lucee+unsubscribe@googlegroups.com
<mailto:lucee%2Bunsubscribe@googlegroups.com>.
> To post to this group, send email to lucee@googlegroups.com <mailto:lucee@googlegroups.com>.
> To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org.
> 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
<mailto:lucee%2Bunsubscribe@googlegroups.com>.
To post to this group, send email to lucee@googlegroups.com
<mailto:lucee@googlegroups.com>.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com.
For more options, visit https://groups.google.com/d/optout.


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/wsuvmNOxnz0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to
lucee+unsubscribe@googlegroups.com
mailto:lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com
mailto:lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%40mail.gmail.com
https://groups.google.com/d/msgid/lucee/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%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
mailto:lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com
mailto:lucee@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/lucee/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com
https://groups.google.com/d/msgid/lucee/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com?utm_medium=email&utm_source=footer.
For more options, visit https://groups.google.com/d/optout.

No need (I think)

I have just committed a bunch of changes,:

  1. default version is now 4.5.1.000
  2. removed old version as the export was iffy
  3. Updated the jsongen.cfm file so that version information is correct
  4. removed the uservoice banner since you can add tickets with…
  5. …the Fork me on Github banner and also make comments with…
  6. … the Disquss module
  7. added a link to tags (soon to add to functions etc) that you can suggest an edit and it points to the right JSON file as well as the right XML file (I think it’s the right file… need to check since it’s doing some version madness)

HTH

Mark Drew

develop • deploy • deliver
http://charliemikedelta.com ttp://charliemikedelta.com> On 20 Feb 2015, at 22:09, Igal @ Lucee.org <@Igal> wrote:

Nando,

the tag and function reference text comes from

https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/tld/web-cfmtaglibrary_1_0 https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/tld/web-cfmtaglibrary_1_0
and
https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/fld/web-cfmfunctionlibrary_1_0 https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/fld/web-cfmfunctionlibrary_1_0

If you find errors or typos you can update those files and submit a patch.

remember that they are xml files so any changes must be xml compliant.

thanks,

Igal Sapir
Lucee Core Developer
Lucee.org http://lucee.org/On 2/20/2015 1:49 PM, Mark Drew wrote:

What the project does is make a bunch of JSON files that are the data files that drive the site (tags, functions, objects) from a lucee server using the following script (no black magic)

https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm

It then generates a folder that you can check out here:

https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json

So you can (at the moment) just send pull requests with changes to each of these files (for the develop branch) and we can then display them in the site when it gets merged into master.

Following up from my email of a while ago, I need to have a way to show content, so I might integrate that into the md files from the wiki or something.

Or just put them in there as there are plenty of markdown -> html solutions out there. I shall add a ticket

Mark Drew

develop • deploy • deliver http://charliemikedelta.com > On 20 Feb 2015, at 21:45, Nando Breiter <@Nando_Breiter > wrote: > > Mark, this looks fantastic. Thanks! > > Do I understand it correctly that the content itself is in the Lucee source code? Where should we submit tickets for typo's and grammatical mistakes? Or maybe a better question might be, how do we maintain and contribute to the documentation as a community without it needing to all go through Micha and Igal (if the content is within the Lucee source). > > > > > > Aria Media Sagl > Via Rompada 40 > 6987 Caslano > Switzerland > > +41 (0)91 600 9601 > +41 (0)76 303 4477 cell > skype: ariamedia > > On Fri, Feb 20, 2015 at 10:22 PM, Mark Drew <@Mark_Drew > wrote: > Cheers for that! I shall get to them next week (house painting this weekend!) > Having said that, there are already pull requests! > > Mark Drew > > > On 20 Feb 2015, at 19:15, Sean Corfield <@Sean_Corfield > wrote: > > > > Thank you! I created a bunch of issues for minor bugs / suggestions. > > > > Sean > > > >> On Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew > wrote: > >> Here you go sah! > >> > >> https://github.com/cybersonic/luceedocs > > > > -- > > 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/wsuvmNOxnz0/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/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org . > > 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/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com . > For more options, visit https://groups.google.com/d/optout . > > > -- > 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/wsuvmNOxnz0/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/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%40mail.gmail.com . > 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 mailto:lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com https://groups.google.com/d/msgid/lucee/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com?utm_medium=email&utm_source=footer.
For more options, visit https://groups.google.com/d/optout 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 mailto:lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/54E7B0B2.2020407%40lucee.org https://groups.google.com/d/msgid/lucee/54E7B0B2.2020407%40lucee.org?utm_medium=email&utm_source=footer.
For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.

That is looking pretty good. Is there a way to now generate everything and then we can edit it? Is the content stored in gihub? Sorry for the dumb questions, the https://readme.io/ https://readme.io/ site doesn’t answer much about this.

We can convert the JSON -> Markdown of course and just create a repo with each version being a tag or branch (can’t remember how readthedocs did it) and that should help

One thing that will be annoying is the left hand navigation. Now it’s pretty long and all that there is are tags, wait till you get to the 500 or so functions!!! And then Member Methods… each page is going to be mighty long.

Mark Drew

develop • deploy • deliver
http://charliemikedelta.com ttp://charliemikedelta.com> On 20 Feb 2015, at 14:45, Michael van Leest <@Michael_van_Leest> wrote:

@Mark: I was already looking at railodocs. I’ve used a similar approach.

http://www.luceedocs.com/v4.5/docs/cfabort http://www.luceedocs.com/v4.5/docs/cfabort

2015-02-20 15:15 GMT+01:00 Mark Drew <@Mark_Drew mailto:Mark_Drew>:

@Nando: I’ve approved the edit just as example.

I need to create some sort of basic template so it’s easier to add new stuff and keep the same layout. I will begin with tags and create the full documentation of cfabort as an example.

Like the ones from Railodocs?

http://www.railodocs.org/tag/cfcache http://www.railodocs.org/tag/cfcache

I have the ejb templates for functions and tags too.

It says it can take stuff from a repo and show it. Sounds like readthedocs.org http://readthedocs.org/?

AH.,I had already registered luceedocs.org and was porting railodocs.org
to it as I mentioned before. Great effort but there is no content? I can
pass you the script that generates the JSON for luceedocs.org if that helps?

Don’t worry about duplicating effort with regards to documentation, better
have more than less.

I was going to work on the Dash docs I have done that before, unless
someone is already doing it?On Friday, February 20, 2015 at 11:27:30 AM UTC, Nando Breiter wrote:

Michael,

If the community gets behind this documentation effort, would you be
willing to transfer “ownership” to the Lucee Association?

I signed up for an account, and I have a Suggest Edits button, which
indicates that a core team would need to review suggestions and approve
them. I don’t have the right to add pages. I think this level of control
over the content while inviting contributions, is a good feature.

I also really like the interface. You can insert text (as markdown),
images, code snippets (either by copying and pasting them or linking from a
Gist), tables (good for explaining attributes of a tag or function when
necessary), embed YouTube videos, jsFiddle snippets, PDFs, etc, insert
callouts, Custom HTML / CSS … this is much more comprehensive than
anything we could build ourselves in a reasonable amount of time. My
opinion only, but I think we should all get behind this solution and go for
it.

Don’t worry about duplicating effort with regards to documentation,
better have more than less.

No. Better have one excellent documentation that everybody uses than two
incomplete ones.

+infinity

Also, do we really need versions?

In my opinion, yes. It’s often not an option to upgrade to the latest and
greatest, and it’s very frustrating to be unable to find docs for the
version you’re stuck on.On Feb 20, 2015 7:13 AM, “Jean Moniatte” <@Jean_Moniatte> wrote:

On Fri, Feb 20, 2015 at 12:33 PM, Mark Drew <@Mark_Drew> wrote:

We did this disco a little while back and I added a link to the XML files from each of the pages in the docs. If people want to update the docs themselves they have to go to the docs an ALSO to the xml files.
There was some discussion and people decided that just updating the docs was fine, hence my comment about how to do it with the current docs.

To be honest, I might put a feature in that you can update the docs but that would lead to a JIRA ticket with the updates for the dev team.

Mark Drew

develop • deploy • deliver
http://charliemikedelta.com ttp://charliemikedelta.com> On 20 Feb 2015, at 22:09, Igal @ Lucee.org <@Igal> wrote:

Nando,

the tag and function reference text comes from

https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/tld/web-cfmtaglibrary_1_0 https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/tld/web-cfmtaglibrary_1_0
and
https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/fld/web-cfmfunctionlibrary_1_0 https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/fld/web-cfmfunctionlibrary_1_0

If you find errors or typos you can update those files and submit a patch.

remember that they are xml files so any changes must be xml compliant.

thanks,

Igal Sapir
Lucee Core Developer
Lucee.org http://lucee.org/On 2/20/2015 1:49 PM, Mark Drew wrote:

What the project does is make a bunch of JSON files that are the data files that drive the site (tags, functions, objects) from a lucee server using the following script (no black magic)

https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm

It then generates a folder that you can check out here:

https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json

So you can (at the moment) just send pull requests with changes to each of these files (for the develop branch) and we can then display them in the site when it gets merged into master.

Following up from my email of a while ago, I need to have a way to show content, so I might integrate that into the md files from the wiki or something.

Or just put them in there as there are plenty of markdown -> html solutions out there. I shall add a ticket

Mark Drew

develop • deploy • deliver http://charliemikedelta.com > On 20 Feb 2015, at 21:45, Nando Breiter <@Nando_Breiter > wrote: > > Mark, this looks fantastic. Thanks! > > Do I understand it correctly that the content itself is in the Lucee source code? Where should we submit tickets for typo's and grammatical mistakes? Or maybe a better question might be, how do we maintain and contribute to the documentation as a community without it needing to all go through Micha and Igal (if the content is within the Lucee source). > > > > > > Aria Media Sagl > Via Rompada 40 > 6987 Caslano > Switzerland > > +41 (0)91 600 9601 > +41 (0)76 303 4477 cell > skype: ariamedia > > On Fri, Feb 20, 2015 at 10:22 PM, Mark Drew <@Mark_Drew > wrote: > Cheers for that! I shall get to them next week (house painting this weekend!) > Having said that, there are already pull requests! > > Mark Drew > > > On 20 Feb 2015, at 19:15, Sean Corfield <@Sean_Corfield > wrote: > > > > Thank you! I created a bunch of issues for minor bugs / suggestions. > > > > Sean > > > >> On Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew > wrote: > >> Here you go sah! > >> > >> https://github.com/cybersonic/luceedocs > > > > -- > > 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/wsuvmNOxnz0/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/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org . > > 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/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com . > For more options, visit https://groups.google.com/d/optout . > > > -- > 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/wsuvmNOxnz0/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/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%40mail.gmail.com . > 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 mailto:lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com https://groups.google.com/d/msgid/lucee/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com?utm_medium=email&utm_source=footer.
For more options, visit https://groups.google.com/d/optout 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 mailto:lucee+unsubscribe@googlegroups.com.
To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/54E7B0B2.2020407%40lucee.org https://groups.google.com/d/msgid/lucee/54E7B0B2.2020407%40lucee.org?utm_medium=email&utm_source=footer.
For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.

Mark, this looks fantastic. Thanks!

Do I understand it correctly that the content itself is in the Lucee source
code? Where should we submit tickets for typo’s and grammatical mistakes?
Or maybe a better question might be, how do we maintain and contribute to
the documentation as a community without it needing to all go through Micha
and Igal (if the content is within the Lucee source).

Aria Media Sagl
Via Rompada 40
6987 Caslano
Switzerland

+41 (0)91 600 9601
+41 (0)76 303 4477 cell
skype: ariamediaOn Fri, Feb 20, 2015 at 10:22 PM, Mark Drew <@Mark_Drew> wrote:

Cheers for that! I shall get to them next week (house painting this
weekend!)
Having said that, there are already pull requests!

Mark Drew

On 20 Feb 2015, at 19:15, Sean Corfield <@Sean_Corfield> wrote:

Thank you! I created a bunch of issues for minor bugs / suggestions.

Sean

On Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew> wrote:
Here you go sah!

https://github.com/cybersonic/luceedocs


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/wsuvmNOxnz0/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/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org
.
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/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com
.
For more options, visit https://groups.google.com/d/optout.

Better to have some documentation then none at all. If someone wants to
create a Lucee documentation site / page / etc, then more power to them.
The best doc site will win in the end. If people rally around one that is
great but don’t discourage someone else from creating something else.

Andrew PenhorwoodOn Friday, February 20, 2015 at 8:13:30 AM UTC-5, jmoniatte wrote:

On Fri, Feb 20, 2015 at 12:33 PM, Mark Drew <mark...@gmail.com <javascript:>> wrote:

Don’t worry about duplicating effort with regards to documentation,
better have more than less.

No. Better have one excellent documentation that everybody uses than two
incomplete ones.

Also, do we really need versions?

I can probably do something that exports the JSON this format, apart from the block:html maybe? If we do this as a file somewhere would that help? So that you don’t have to manually do this for every tag/function?

Mark Drew

develop • deploy • deliver
http://charliemikedelta.com ttp://charliemikedelta.com> On 20 Feb 2015, at 15:01, Michael van Leest <@Michael_van_Leest> wrote:

@Mark: This is what the raw data of cfabort looks like:

[block:html]
{
“html”: “<ul class=“list-inline”>\n

  • <a href=”#summary">Summary
  • \n
  • &middot
  • \n
  • <a href="#attributes">Attributes
  • \n
  • &middot
  • \n
  • <a href="#tag-examples">Tag examples
  • \n
  • &middot
  • \n
  • <a href="#script-examples">Script examples
  • \n
  • &middot
  • \n
  • <a href="#external-examples">External examples
  • \n\n
    "
    }
    [/block]

    [block:api-header]
    {
    “type”: “basic”,
    “title”: “Summary”
    }
    [/block]
    Stops processing of a page at the tag location. Lucee returns everything that was processed before the cfabort tag. The cfabort tag is often used with conditional logic to stop processing a page when a condition occurs.
    [block:api-header]
    {
    “type”: “basic”,
    “title”: “Attributes”
    }
    [/block]

    [block:parameters]
    {
    “data”: {
    “h-0”: “Name”,
    “h-1”: “Type”,
    “h-2”: “Required”,
    “h-3”: “Description”,
    “0-0”: “type”,
    “0-3”: “Define if only current page execution will aborted or the hole request.\nValues are “page” for the current page or “request” for all.”,
    “1-0”: “showerror”,
    “0-1”: “string”,
    “1-1”: “string”,
    “0-2”: “No”,
    “1-2”: “No”,
    “1-3”: “The error to display when cfabort executes.\nThe error message displays in the standard CFML error page.”
    },
    “cols”: 4,
    “rows”: 2
    }
    [/block]

    [block:api-header]
    {
    “title”: “Tag examples”,
    “type”: “basic”
    }
    [/block]

    [block:code]
    {
    “codes”: [
    {
    “code”: “This will be output\n\nThis will not”,
    “language”: “text”,
    “name”: “cfabort.cfm”
    }
    ]
    }
    [/block]

    [block:api-header]
    {
    “type”: “basic”,
    “title”: “Script examples”
    }
    [/block]

    [block:code]
    {
    “codes”: [
    {
    “code”: “This will be output\n\n\tabort;\n\nThis will not”,
    “language”: “text”,
    “name”: “cfabort.cfm”
    }
    ]
    }
    [/block]

    [block:api-header]
    {
    “type”: “basic”,
    “title”: “External examples”
    }
    [/block]
    There are currently no external examples available for cfabort. Please submit any good resources (blog posts, mailing list messages, etc) about this specific tag.

    2015-02-20 15:58 GMT+01:00 Michael van Leest <@Michael_van_Leest mailto:Michael_van_Leest>:
    Between the lines.

    2015-02-20 15:52 GMT+01:00 Mark Drew <@Mark_Drew mailto:Mark_Drew>:
    That is looking pretty good. Is there a way to now generate everything and then we can edit it? Is the content stored in gihub? Sorry for the dumb questions, the https://readme.io/ https://readme.io/ site doesn’t answer much about this.

    It’s a git project, but I as far as I’ve seen, it’s a private git system they use.

    We can convert the JSON -> Markdown of course and just create a repo with each version being a tag or branch (can’t remember how readthedocs did it) and that should help

    One thing that will be annoying is the left hand navigation. Now it’s pretty long and all that there is are tags, wait till you get to the 500 or so functions!!! And then Member Methods… each page is going to be mighty long.

    I’ve filed a enhancement request for that to make groups collapsable (and collapsed as default). It’s automatically generated from the files that are created, so no custom stuff in the side menu for now.

    Mark Drew

    <cmd.png>
    develop • deploy • deliver
    http://charliemikedelta.com <>

    On 20 Feb 2015, at 14:45, Michael van Leest <@Michael_van_Leest mailto:Michael_van_Leest> wrote:

    @Mark: I was already looking at railodocs. I’ve used a similar approach.

    http://www.luceedocs.com/v4.5/docs/cfabort http://www.luceedocs.com/v4.5/docs/cfabort

    2015-02-20 15:15 GMT+01:00 Mark Drew <@Mark_Drew mailto:Mark_Drew>:

    @Nando: I’ve approved the edit just as example.

    I need to create some sort of basic template so it’s easier to add new stuff and keep the same layout. I will begin with tags and create the full documentation of cfabort as an example.

    Like the ones from Railodocs?

    http://www.railodocs.org/tag/cfcache http://www.railodocs.org/tag/cfcache

    I have the ejb templates for functions and tags too.

    It says it can take stuff from a repo and show it. Sounds like readthedocs.org http://readthedocs.org/?


    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 mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/4BB6419D-375B-42D0-91CC-CB39F756F3CB%40gmail.com https://groups.google.com/d/msgid/lucee/4BB6419D-375B-42D0-91CC-CB39F756F3CB%40gmail.com?utm_medium=email&utm_source=footer.
    For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.


    Michael van Leest


    Michael van Leest


    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/wsuvmNOxnz0/unsubscribe https://groups.google.com/d/topic/lucee/wsuvmNOxnz0/unsubscribe.
    To unsubscribe from this group and all its topics, send an email to lucee+unsubscribe@googlegroups.com mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAMaJE6u%3D0vn1sDrdgkfohSDeEeLLe0Mmcx5qvYL642xs52kN_A%40mail.gmail.com https://groups.google.com/d/msgid/lucee/CAMaJE6u%3D0vn1sDrdgkfohSDeEeLLe0Mmcx5qvYL642xs52kN_A%40mail.gmail.com?utm_medium=email&utm_source=footer.
    For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.

    Awesome work sir! Great idea to use md for descriptions. Check out the work I started on “random docs” in the feature/docs branch.

    Will merge tomorrow!

    Mark Drew> On 20 Feb 2015, at 23:21, Jon Clausen <@Jon_Clausen> wrote:

    Mark,

    Not quite, though it doesn’t mess up the display jumbotron container display as much. That imageFilter description is also markdown formatted so it’s a big unformatted blob of text when displayed.

    I just submitted a pull request which adds markdown rendering of the descriptions and a conditional “Full Description” section when the description in the JSON is over 300 chars.

    Jon

    On February 20, 2015 at 5:28:46 PM, Mark Drew (@Mark_Drew) wrote:

    No need (I think)

    I have just committed a bunch of changes,:

    1. default version is now 4.5.1.000
    2. removed old version as the export was iffy
    3. Updated the jsongen.cfm file so that version information is correct
    4. removed the uservoice banner since you can add tickets with…
    5. …the Fork me on Github banner and also make comments with…
    6. … the Disquss module
    7. added a link to tags (soon to add to functions etc) that you can suggest an edit and it points to the right JSON file as well as the right XML file (I think it’s the right file… need to check since it’s doing some version madness)

    HTH

    Mark Drew

    4E4D7F71-BA2B-4509-8A23-566E02A542DD@home
    develop • deploy • deliver
    http://charliemikedelta.com

    On 20 Feb 2015, at 22:09, Igal @ Lucee.org <@Igal> wrote:

    Nando,

    the tag and function reference text comes from

    https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/tld/web-cfmtaglibrary_1_0
    and
    https://bitbucket.org/lucee/lucee/src/master/lucee-java/lucee-core/src/resource/fld/web-cfmfunctionlibrary_1_0

    If you find errors or typos you can update those files and submit a patch.

    remember that they are xml files so any changes must be xml compliant.

    thanks,

    Igal Sapir
    Lucee Core Developer
    Lucee.org

    On 2/20/2015 1:49 PM, Mark Drew wrote:
    What the project does is make a bunch of JSON files that are the data files that drive the site (tags, functions, objects) from a lucee server using the following script (no black magic)

    https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm

    It then generates a folder that you can check out here:

    https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json

    So you can (at the moment) just send pull requests with changes to each of these files (for the develop branch) and we can then display them in the site when it gets merged into master.

    Following up from my email of a while ago, I need to have a way to show content, so I might integrate that into the md files from the wiki or something.

    Or just put them in there as there are plenty of markdown -> html solutions out there. I shall add a ticket

    Mark Drew

    develop • deploy • deliver http://charliemikedelta.com

    On 20 Feb 2015, at 21:45, Nando Breiter <@Nando_Breiter> wrote:

    Mark, this looks fantastic. Thanks!

    Do I understand it correctly that the content itself is in the Lucee source code? Where should we submit tickets for typo’s and grammatical mistakes? Or maybe a better question might be, how do we maintain and contribute to the documentation as a community without it needing to all go through Micha and Igal (if the content is within the Lucee source).

    Aria Media Sagl
    Via Rompada 40
    6987 Caslano
    Switzerland

    +41 (0)91 600 9601
    +41 (0)76 303 4477 cell
    skype: ariamedia

    On Fri, Feb 20, 2015 at 10:22 PM, Mark Drew <@Mark_Drew> wrote:
    Cheers for that! I shall get to them next week (house painting this weekend!)
    Having said that, there are already pull requests!

    Mark Drew

    On 20 Feb 2015, at 19:15, Sean Corfield <@Sean_Corfield> wrote:

    Thank you! I created a bunch of issues for minor bugs / suggestions.

    Sean

    On Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew> wrote:
    Here you go sah!

    https://github.com/cybersonic/luceedocs


    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/wsuvmNOxnz0/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/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org.
    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/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com.
    For more options, visit https://groups.google.com/d/optout.


    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/wsuvmNOxnz0/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/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%40mail.gmail.com.
    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/163C0286-8330-4B7D-ACF8-D2168E8E29BD%40gmail.com.
    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/54E7B0B2.2020407%40lucee.org.
    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/8C674A2C-187E-4565-BCBB-FC08BB450A28%40gmail.com.
    For more options, visit https://groups.google.com/d/optout.

    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/wsuvmNOxnz0/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/etPan.54e7c179.2e4327b0.15e12%40jonclausen-mbp.local.
    For more options, visit https://groups.google.com/d/optout.

    Thank you! I created a bunch of issues for minor bugs / suggestions.

    SeanOn Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew> wrote:

    Here you go sah!

    https://github.com/cybersonic/luceedocs

    What the project does is make a bunch of JSON files that are the data files that drive the site (tags, functions, objects) from a lucee server using the following script (no black magic)

    https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm https://github.com/cybersonic/luceedocs/blob/luceedocs/jsongen.cfm

    It then generates a folder that you can check out here:

    https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json https://github.com/cybersonic/luceedocs/tree/luceedocs/export/4.5.0.042/json

    So you can (at the moment) just send pull requests with changes to each of these files (for the develop branch) and we can then display them in the site when it gets merged into master.

    Following up from my email of a while ago, I need to have a way to show content, so I might integrate that into the md files from the wiki or something.

    Or just put them in there as there are plenty of markdown -> html solutions out there. I shall add a ticket

    Mark Drew

    develop • deploy • deliver
    http://charliemikedelta.com ttp://charliemikedelta.com> On 20 Feb 2015, at 21:45, Nando Breiter <@Nando_Breiter> wrote:

    Mark, this looks fantastic. Thanks!

    Do I understand it correctly that the content itself is in the Lucee source code? Where should we submit tickets for typo’s and grammatical mistakes? Or maybe a better question might be, how do we maintain and contribute to the documentation as a community without it needing to all go through Micha and Igal (if the content is within the Lucee source).

    Aria Media Sagl
    Via Rompada 40
    6987 Caslano
    Switzerland

    +41 (0)91 600 9601
    +41 (0)76 303 4477 cell
    skype: ariamedia

    On Fri, Feb 20, 2015 at 10:22 PM, Mark Drew <@Mark_Drew mailto:Mark_Drew> wrote:
    Cheers for that! I shall get to them next week (house painting this weekend!)
    Having said that, there are already pull requests!

    Mark Drew

    On 20 Feb 2015, at 19:15, Sean Corfield <@Sean_Corfield mailto:Sean_Corfield> wrote:

    Thank you! I created a bunch of issues for minor bugs / suggestions.

    Sean

    On Feb 20, 2015, at 10:58 AM, Mark Drew <@Mark_Drew mailto:Mark_Drew> wrote:
    Here you go sah!

    https://github.com/cybersonic/luceedocs https://github.com/cybersonic/luceedocs


    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/wsuvmNOxnz0/unsubscribe https://groups.google.com/d/topic/lucee/wsuvmNOxnz0/unsubscribe.
    To unsubscribe from this group and all its topics, send an email to lucee+unsubscribe@googlegroups.com mailto:lucee%2Bunsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org https://groups.google.com/d/msgid/lucee/82BD30FC-E25E-4236-8C6E-418286550FE8%40corfield.org.
    For more options, visit https://groups.google.com/d/optout 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 mailto:lucee%2Bunsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com https://groups.google.com/d/msgid/lucee/507D0B9F-2B95-41CA-AEFA-C2BF250A16E8%40gmail.com.
    For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.


    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/wsuvmNOxnz0/unsubscribe https://groups.google.com/d/topic/lucee/wsuvmNOxnz0/unsubscribe.
    To unsubscribe from this group and all its topics, send an email to lucee+unsubscribe@googlegroups.com mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%40mail.gmail.com https://groups.google.com/d/msgid/lucee/CAGHrs%3D_r1Z__oSwo0VSF4kLRXbs0sGKF-ZddLQeYcwSgjn4KoQ%40mail.gmail.com?utm_medium=email&utm_source=footer.
    For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.

    Michael,

    If the community gets behind this documentation effort, would you be
    willing to transfer “ownership” to the Lucee Association?

    I signed up for an account, and I have a Suggest Edits button, which
    indicates that a core team would need to review suggestions and approve
    them. I don’t have the right to add pages. I think this level of control
    over the content while inviting contributions, is a good feature.

    I also really like the interface. You can insert text (as markdown),
    images, code snippets (either by copying and pasting them or linking from a
    Gist), tables (good for explaining attributes of a tag or function when
    necessary), embed YouTube videos, jsFiddle snippets, PDFs, etc, insert
    callouts, Custom HTML / CSS … this is much more comprehensive than
    anything we could build ourselves in a reasonable amount of time. My
    opinion only, but I think we should all get behind this solution and go for
    it.

    Aria Media Sagl
    Via Rompada 40
    6987 Caslano
    Switzerland

    +41 (0)91 600 9601
    +41 (0)76 303 4477 cell
    skype: ariamediaOn Fri, Feb 20, 2015 at 11:59 AM, Michael van Leest <@Michael_van_Leest> wrote:

    Hi Nando,

    Yes, I have the Open Source discount from them, so no worries there. I’m
    actively in contact with them for functionality enhancements and UX
    enhancements, so along the way we help them shape the product as a thank
    you.

    I’ll add a TO-DO document later today/this weekend. So if someone wants to
    start on a document, they can add their name to the document so everyone
    knows who is working on it.

    The import option is currently not working, so that is not an option at
    this time. I’m setting up all the files myself the coming days and provide
    a base template for a tag, function and object so people can copy that if
    they want to start adding stuff to a new page.

    I’ll update on my progress here and let you know when we can start writing!

    Thanks!

    2015-02-20 11:36 GMT+01:00 Nando Breiter <@Nando_Breiter>:

    Michael,

    Seems like a good start to me, especially in that it is a platform
    designed for documentation. The only thing I’m concerned about is that we
    don’t duplicate the effort.

    An interesting bit I see in the FAQ: if you document your API right in
    your code, you can import it from GitHub! We’ll create stubs from the code,
    and you can edit the rest on the site.

    And

    ReadMe was built almost entirely on Open Source projects, so we want to
    give back. If you’re an open source project, shoot us an email and we’ll
    upgrade you to the Developer Hub tier for free. It’s the least we can do to
    give back.

    Aria Media Sagl
    Via Rompada 40
    6987 Caslano
    Switzerland

    +41 (0)91 600 9601
    +41 (0)76 303 4477 cell
    skype: ariamedia

    On Fri, Feb 20, 2015 at 10:25 AM, Michael van Leest <@Michael_van_Leest> wrote:

    Hi everyone,

    I made a start of setting up a docs website for Lucee with the help from
    readme.io.
    They supported by giving me a free license and are looking into cfml
    code colouring support so we can show cfml code examples.

    Over the coming days I’ll be adding docs for tags and functions and was
    hoping 1 or 2 list members could help me with writing examples.

    You can find it on luceedocs.com

    Let me know what you guys think and if you have any pointers, let me
    know (or provide enhancements on the luceedocs.com site.

    Regards,


    Michael van Leest


    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/CAMaJE6tpcvh4atS8yL4hhQy37pmUj5EDztqjBk0KjNGrkAtwEA%40mail.gmail.com
    https://groups.google.com/d/msgid/lucee/CAMaJE6tpcvh4atS8yL4hhQy37pmUj5EDztqjBk0KjNGrkAtwEA%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/CAGHrs%3D_ADJpcfBFB6ajDNsf-RqOTxa-8yF7yfozUmNLV1B_A1w%40mail.gmail.com
    https://groups.google.com/d/msgid/lucee/CAGHrs%3D_ADJpcfBFB6ajDNsf-RqOTxa-8yF7yfozUmNLV1B_A1w%40mail.gmail.com?utm_medium=email&utm_source=footer
    .
    For more options, visit https://groups.google.com/d/optout.


    Michael van Leest


    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/CAMaJE6sh76kdNZjMFenErAPBso6Z%2BVP6aKqXRR5bA8gDg4KeSQ%40mail.gmail.com
    https://groups.google.com/d/msgid/lucee/CAMaJE6sh76kdNZjMFenErAPBso6Z%2BVP6aKqXRR5bA8gDg4KeSQ%40mail.gmail.com?utm_medium=email&utm_source=footer
    .

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

    @Nando: I’ve approved the edit just as example.

    I need to create some sort of basic template so it’s easier to add new stuff and keep the same layout. I will begin with tags and create the full documentation of cfabort as an example.

    Like the ones from Railodocs?

    http://www.railodocs.org/tag/cfcache http://www.railodocs.org/tag/cfcache

    I have the ejb templates for functions and tags too.

    It says it can take stuff from a repo and show it. Sounds like readthedocs.org http://readthedocs.org/?

    MD

    Doesn’t it say they can import it from a github account?

    I just emailed them to find out how we could just import this. They have an API for publishing stuff, but copy and pasting… you will die of old age :slight_smile: Trust me,

    I shall wait to hear what they say.

    Mark Drew

    develop • deploy • deliver
    http://charliemikedelta.com ttp://charliemikedelta.com> On 20 Feb 2015, at 15:10, Michael van Leest <@Michael_van_Leest> wrote:

    If you can export it in that way for every tag, that would save huge amounts of time!
    I have to do it for each tag, but that is fine. So 1 file per tag would be ideal and I’ll update each page with a simple copy/paste.

    2015-02-20 16:04 GMT+01:00 Mark Drew <@Mark_Drew mailto:Mark_Drew>:
    I can probably do something that exports the JSON this format, apart from the block:html maybe? If we do this as a file somewhere would that help? So that you don’t have to manually do this for every tag/function?

    Mark Drew

    <cmd.png>
    develop • deploy • deliver
    http://charliemikedelta.com <>

    On 20 Feb 2015, at 15:01, Michael van Leest <@Michael_van_Leest mailto:Michael_van_Leest> wrote:

    @Mark: This is what the raw data of cfabort looks like:

    [block:html]
    {
    “html”: “<ul class=“list-inline”>\n

  • <a href=”#summary">Summary
  • \n
  • &middot
  • \n
  • <a href="#attributes">Attributes
  • \n
  • &middot
  • \n
  • <a href="#tag-examples">Tag examples
  • \n
  • &middot
  • \n
  • <a href="#script-examples">Script examples
  • \n
  • &middot
  • \n
  • <a href="#external-examples">External examples
  • \n\n
    "
    }
    [/block]

    [block:api-header]
    {
    “type”: “basic”,
    “title”: “Summary”
    }
    [/block]
    Stops processing of a page at the tag location. Lucee returns everything that was processed before the cfabort tag. The cfabort tag is often used with conditional logic to stop processing a page when a condition occurs.
    [block:api-header]
    {
    “type”: “basic”,
    “title”: “Attributes”
    }
    [/block]

    [block:parameters]
    {
    “data”: {
    “h-0”: “Name”,
    “h-1”: “Type”,
    “h-2”: “Required”,
    “h-3”: “Description”,
    “0-0”: “type”,
    “0-3”: “Define if only current page execution will aborted or the hole request.\nValues are “page” for the current page or “request” for all.”,
    “1-0”: “showerror”,
    “0-1”: “string”,
    “1-1”: “string”,
    “0-2”: “No”,
    “1-2”: “No”,
    “1-3”: “The error to display when cfabort executes.\nThe error message displays in the standard CFML error page.”
    },
    “cols”: 4,
    “rows”: 2
    }
    [/block]

    [block:api-header]
    {
    “title”: “Tag examples”,
    “type”: “basic”
    }
    [/block]

    [block:code]
    {
    “codes”: [
    {
    “code”: “This will be output\n\nThis will not”,
    “language”: “text”,
    “name”: “cfabort.cfm”
    }
    ]
    }
    [/block]

    [block:api-header]
    {
    “type”: “basic”,
    “title”: “Script examples”
    }
    [/block]

    [block:code]
    {
    “codes”: [
    {
    “code”: “This will be output\n\n\tabort;\n\nThis will not”,
    “language”: “text”,
    “name”: “cfabort.cfm”
    }
    ]
    }
    [/block]

    [block:api-header]
    {
    “type”: “basic”,
    “title”: “External examples”
    }
    [/block]
    There are currently no external examples available for cfabort. Please submit any good resources (blog posts, mailing list messages, etc) about this specific tag.

    2015-02-20 15:58 GMT+01:00 Michael van Leest <@Michael_van_Leest mailto:Michael_van_Leest>:
    Between the lines.

    2015-02-20 15:52 GMT+01:00 Mark Drew <@Mark_Drew mailto:Mark_Drew>:
    That is looking pretty good. Is there a way to now generate everything and then we can edit it? Is the content stored in gihub? Sorry for the dumb questions, the https://readme.io/ https://readme.io/ site doesn’t answer much about this.

    It’s a git project, but I as far as I’ve seen, it’s a private git system they use.

    We can convert the JSON -> Markdown of course and just create a repo with each version being a tag or branch (can’t remember how readthedocs did it) and that should help

    One thing that will be annoying is the left hand navigation. Now it’s pretty long and all that there is are tags, wait till you get to the 500 or so functions!!! And then Member Methods… each page is going to be mighty long.

    I’ve filed a enhancement request for that to make groups collapsable (and collapsed as default). It’s automatically generated from the files that are created, so no custom stuff in the side menu for now.

    Mark Drew

    <cmd.png>
    develop • deploy • deliver
    http://charliemikedelta.com <>

    On 20 Feb 2015, at 14:45, Michael van Leest <@Michael_van_Leest mailto:Michael_van_Leest> wrote:

    @Mark: I was already looking at railodocs. I’ve used a similar approach.

    http://www.luceedocs.com/v4.5/docs/cfabort http://www.luceedocs.com/v4.5/docs/cfabort

    2015-02-20 15:15 GMT+01:00 Mark Drew <@Mark_Drew mailto:Mark_Drew>:

    @Nando: I’ve approved the edit just as example.

    I need to create some sort of basic template so it’s easier to add new stuff and keep the same layout. I will begin with tags and create the full documentation of cfabort as an example.

    Like the ones from Railodocs?

    http://www.railodocs.org/tag/cfcache http://www.railodocs.org/tag/cfcache

    I have the ejb templates for functions and tags too.

    It says it can take stuff from a repo and show it. Sounds like readthedocs.org http://readthedocs.org/?


    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 mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/4BB6419D-375B-42D0-91CC-CB39F756F3CB%40gmail.com https://groups.google.com/d/msgid/lucee/4BB6419D-375B-42D0-91CC-CB39F756F3CB%40gmail.com?utm_medium=email&utm_source=footer.
    For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.


    Michael van Leest


    Michael van Leest


    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/wsuvmNOxnz0/unsubscribe https://groups.google.com/d/topic/lucee/wsuvmNOxnz0/unsubscribe.
    To unsubscribe from this group and all its topics, send an email to lucee+unsubscribe@googlegroups.com mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAMaJE6u%3D0vn1sDrdgkfohSDeEeLLe0Mmcx5qvYL642xs52kN_A%40mail.gmail.com https://groups.google.com/d/msgid/lucee/CAMaJE6u%3D0vn1sDrdgkfohSDeEeLLe0Mmcx5qvYL642xs52kN_A%40mail.gmail.com?utm_medium=email&utm_source=footer.
    For more options, visit https://groups.google.com/d/optout 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 mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/9C11EE3B-DA91-4BC4-B8FE-D2B0F44DD076%40gmail.com https://groups.google.com/d/msgid/lucee/9C11EE3B-DA91-4BC4-B8FE-D2B0F44DD076%40gmail.com?utm_medium=email&utm_source=footer.

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


    Michael van Leest


    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/wsuvmNOxnz0/unsubscribe https://groups.google.com/d/topic/lucee/wsuvmNOxnz0/unsubscribe.
    To unsubscribe from this group and all its topics, send an email to lucee+unsubscribe@googlegroups.com mailto:lucee+unsubscribe@googlegroups.com.
    To post to this group, send email to lucee@googlegroups.com mailto:lucee@googlegroups.com.
    To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAMaJE6sRG0LAqNud4L0%3Dqx56L4fAPDWUPAaMcXwKkGsSL4SiHw%40mail.gmail.com https://groups.google.com/d/msgid/lucee/CAMaJE6sRG0LAqNud4L0%3Dqx56L4fAPDWUPAaMcXwKkGsSL4SiHw%40mail.gmail.com?utm_medium=email&utm_source=footer.
    For more options, visit https://groups.google.com/d/optout https://groups.google.com/d/optout.