I recently wrote a very simple Web Content Manager System called DocumentJunction using Elevate Web Builder and some other tools (Nice Toolkit, Apache web server, PHP).

I did it  because I was frustrated with the existing options for adding documentation to software projects and because I need to allow power users the ability to edit documentation without forcing them to use convoluted processes to update the documentation.

Usually I would add a button to bring up a TBrowser to display documents written in Word exported to ugly HTML or worse, PDF.  PDFs are not acceptable to many clients because they are not accessible for those with special needs.  And when you make a change, you have to re-export from Word, copy all the files, and it's a major pain.

Now I use the same TBrowser, but bring up a folder from DocumentJunction.  Editing is as easy as pressing a link.  You can include text, fonts, colours, images, and hyperlinks.  You pop in and out of the editor in mere seconds.

Because the system generates pure HTML (JavaScript is only used if you go into Edit mode), the content is easily indexed by Google to be made world readable, or, if I have secrets, placed behind access restrictions (thanks to Apache's configurability).

I made a short video showing how it works
https://www.youtube.com/watch?v=JZG4pylpT4I

On some sites, I have it integrated with ADFS and Mulitifactor logins.  But you only need to login once, which is why the video doesn't show it prompting me for passwords.

You can learn more details at:
https://erickengelke.com/dj/root/documentjunction/index.php
Contact me if you are interested.

So, I was wondering, what do other people use for documenting their projects?  Are there any lessons you learned?

Erick
EWB Programming Books and Component Library
http://www.erickengelke.com

erickengelke wrote:

> So, I was wondering, what do other people use for documenting their projects?  Are there any lessons you learned?

Nice job!  Congratulations!  You have pretty much solved the problems I have faced especially being indexed by Google.  I've done everything manually.  I haven't done REST API documentation yet but I do find the format of readme.com very nice.

I have wanted to do exactly what you have done but I haven't had time.  I realize we can use the Quill Rich Text editor but I have been hoping for the HTML Rich Text Editor component.

I've tried doing one myself but I haven't been successful.  I enjoy EWB's client side and would like for it to be built in.

Thanks for sharing!

Best regards,
Allen

Allen W. Hunt wrote:

> erickengelke wrote:
>> So, I was wondering, what do other people use for documenting their projects?  
>> Are there any lessons you learned?

> Congratulations!  You have pretty much solved the problems I have faced especially
> being indexed by Google.  I've done everything manually.  I haven't done REST API
> documentation yet but I do find the format of readme.com very nice.

CSS is certainly not my strength, but readme.com does a good job of it.

> I have wanted to do exactly what you have done but I haven't had time.  
> I realize we can use the Quill Rich Text editor but I have been hoping for the HTML Rich Text Editor component.

Yes, I used Quill and also a Quill extension that lets you essentially cut-and-paste from Word and it cleans it up.

There are downsides to using stock things like Quill - stuff that you notice the deeper you get into a project, but one of the upsides is that there are many available extensions to add functionality you may want or need.  I haven't yet figured out how to extend it with EWB, but it offers hooks that make extensions possible.

> I've tried doing one myself but I haven't been successful.
> I enjoy EWB's client side and would like for it to be built in.

That would be nice indeed.  I would gladly prefer to use a native component.  I figure it would take roughly 100 high-end developer hours to make something like quill... minimum, more if you go down the wrong rabbit holes along the way.   

Erick
EWB Programming Books and Component Library
http://www.erickengelke.com

erickengelke wrote:

> Yes, I used Quill and also a Quill extension that lets you essentially cut-and-paste from Word and it cleans it up.

> There are downsides to using stock things like Quill - stuff that you notice the deeper you get into a project, but > one of the upsides is that there are many available extensions to add functionality you may want or need.  I ? > haven't yet figured out how to extend it with EWB, but it offers hooks that make extensions possible.

Thank you.  Maybe I will get a chance to check it out more.

> That would be nice indeed.  I would gladly prefer to use a native component.  I figure it would take roughly 100 > high-end developer hours to make something like quill... minimum, more if you go down the wrong rabbit holes > along the way.   

I agree!  I went down some rabbit holes.  I've tried to get a grasp how Tim developed EWB but ultimately, I'm stuck.  I've dabbled with Smart Mobile Studio, TMS Scripter, and one other (I can't remember) and I haven't figure it out.  

The way EWB has an interface manager, absolute element positioning, layout, display order, layout order to get accomplish WYSIWIG is mind blowing to say the least.  It's great work!

I want to know how the TileComboBox works at a lower level so I can have one with a Multiple Files toggle property.

I'm either missing the point on how he created the components to be extended or I need the code at a deeper level.  I don't know I haven't figured it out yet.

I seem to keep getting stuck trying to extend components with Javascript rather than Pascal.  I would rather everything be in Pascal that is the goal of EWB.

Thank you!  

Best regards,
Allen

Allen W. Hunt wrote:

erickengelke wrote:

> I agree!  I went down some rabbit holes.  I've tried to get a grasp how Tim developed EWB but ultimately, I'm stuck.  I've dabbled with Smart Mobile Studio, TMS Scripter, and one other (I can't remember) and I haven't figure it out.  

> The way EWB has an interface manager, absolute element positioning, layout, display order, layout order to get accomplish WYSIWIG is mind blowing to say the least.  It's great work!

Agreed.  The day I learned to use EWB's responsive design was the beginning of a new era in my EWB apps.

>I seem to keep getting stuck trying to extend components with Javascript rather than Pascal.  I would rather everything be in Pascal that is the goal of EWB.

It's always a question of taking time to reinvent the wheel versus gaining the benefits of native EWB code.  I struggle with that too.   I've taken the stance of always using pure EWB code while interfacing with other people's Javascript libraries when the code in EWB would be too onerous.

There are only a few things you cannot do with EWB that you can with Javascript or competitor products - unfortunately, promise support and Javascript ASYNC functionality being missing is a frustration I have to use tricks to work around for tools like the camera control in my Nice libraries.

Erick
.
EWB Programming Books and Component Library
http://www.erickengelke.com

erickengelke wrote:

> Agreed.  The day I learned to use EWB's responsive design was the beginning of a new era in my EWB apps.

Absolutely!  I don't know if there is a tutorial video anywhere but it definitely changed the way I saw EWB once I understood it.  After a quick glance, I don't see one on the Elevate Software, Inc. YouTube channel.  I could have missed it.  It might help attract people.  Personally, I remember digging into the manual learning how to do it.

I used the responsive example and actually the animation example with EWB 2 also.  I don't see the same examples in EWB 3 that are included in EWB 2.  

I do see a Control Creation video on the YouTube channel that is helpful but I still need to learn more.  I'll try and take some time digging into Tim's and your code the Nice Component Library.  Congratulations on that by the way!  You've been a real help to me getting up to speed on EWB.

> It's always a question of taking time to reinvent the wheel versus gaining the benefits of native EWB code.  I struggle with that too.   I've taken the stance of always using pure EWB code while interfacing with other ?people's Javascript libraries when the code in EWB would be too onerous.

That is for sure a great approach!

> There are only a few things you cannot do with EWB that you can with Javascript or competitor products - unfortunately, promise support and Javascript ASYNC functionality being missing is a frustration I have to use tricks to work around for tools like the camera control in my Nice libraries.

I took a look at the roadmap and I see "Sync keyword for waiting on asynchronous functions/methods".  Maybe that's the ASYNC functionality your looking for.  I don't see support for promises and I don't see the HTML Rich Edit component that has been discussed before in the forum.  I am aware that EWB 3 installs a webeditor.wbs in the libraries folder.  So it looks he has been working on it.

Thank you!

Best regards,
Allen

Allen Hunt wrote:
> I am aware that EWB 3 installs a webeditor.wbs in the libraries folder.  So it looks he has been working on it.

Yes, it looks promising.  I had a peek tonight.

Also tonight I was looking at a new open source editor called TipTap, which does some cool things.  What I like about it is that it is headless, letting you define your UI and doesn't;'t make a lot of assumptions.  While I'm not suggesting people switch to it, it does some things better than all other editors so would be a good inspiration for making an extensible editor.

Erick
EWB Programming Books and Component Library
http://www.erickengelke.com