The X# Documentation Project

This forum is meant for anything you would like to share with other visitors
User avatar
rjpajaron
Posts: 364
Joined: Fri Nov 06, 2015 12:01 am

The X# Documentation Project

Post by rjpajaron »

hi Wolfgang,

This is great. Xsharp online docs will remain as is as COMPLETE REFERENCE (still incomplete); while the wiki will provide as one stop shop docs where people can fill in and edit with real-life experience.

Let me in...

Regards,

Rene
User avatar
rjpajaron
Posts: 364
Joined: Fri Nov 06, 2015 12:01 am

The X# Documentation Project

Post by rjpajaron »

Wolfgang Riedmann wrote:Hello,

in the many contacts I had over the last months, I have learned that the biggest problem people encounters when starting with X# is the documentation. And documentation don't necessarily means "Syntax documentation", but most of the time small code samples and "How do I" or "How works this".
Remembering the problems I had myself, I can understand this fully.

And since the development team is very busy developing the X# runtime (we need that too!), and since I think some issues are better explained from a users point of view, I have decided to setup a wiki for this.

I have dedicated a lot of time in the last 3 weeks to this projects, and now I think it is time to present:

The X# Documentation Project

This projects is not yet complete, and it will never be completed.
Of course, if someone likes to contribute, he is very welcome to do so.
If you find errors, please let me know!
If you miss topics that need to be added, please let me know!

Wolfgang
Furthermore, we need advanced samples that are common among enterprise apps in VO:

1. bBrowser sample, before and after.
2. ReportPro 3 and 2, before and after.
3. All the Fabs... Fabrice is doing a great job on that one

Myself, I have to find a way to contribute in smaller way using my experience.

Regards,

Rene
User avatar
wriedmann
Posts: 3765
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

Hi Rene,
Furthermore, we need advanced samples that are common among enterprise apps in VO:

1. bBrowser sample, before and after.
2. ReportPro 3 and 2, before and after.
3. All the Fabs... Fabrice is doing a great job on that one
This is the job of the relative producers.
For bBrower, only Joachim Bieler can produce a X# version of bBrowser (and AFAIK such a project is in the works).
For ReportPro there are new versions that should also be usable from X# - for FoX members they are available.
And for Fabrices libraries: yes, he is working on them.

So these problems are on the way to be solved.

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
User avatar
Phil Hepburn
Posts: 743
Joined: Sun Sep 11, 2016 2:16 pm

The X# Documentation Project

Post by Phil Hepburn »

Thanks a lot Wolfgang,

I will gradually work on this mini-project of making my most modern / meaningful eNotes files available to anyone who wishes to use them.

Most are not going to change - much or at all - except the 'ClickStartXSharp' CHM file. There is still a huge amount of work to be done there, and so I will update it from time to time. Keeping the version number in the filename is probably going to help most of us track what we are doing.

I will also come up with a smarter way to identify "which does what" so we all can tell the possible contents ;-0)

At the moment I am uploading a handful of CHMs to your server, via the FTP access you provided to me.
Regards,
Phil.
Wales, UK.
User avatar
wriedmann
Posts: 3765
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

Hi Phil,

I will try to give the site a more friendly look in the next days....

Do you have a logo file that I could put there?

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
User avatar
Phil Hepburn
Posts: 743
Joined: Sun Sep 11, 2016 2:16 pm

The X# Documentation Project

Post by Phil Hepburn »

Hi Wolfgang,

I will work on it - but at the moment I am sill uploading CHMs via 'FileZilla'. A great bit of software !

I am hoping to have all the files I prepared for conferences in the past ten years - some good stuff in there somewhere ;-0) And it all worked when it was put into the eNotes.

Also there are fundamental ones on SQL, WPF, XAML, MVVM, LINQ, PowerShell, Reporting Services, Visual Studio, etc., etc., etc..

I will make some sort of lookup table so guys can see what is/does what. I don't wish to change the file names - as I have been consistently using a naming system for about ten years.

Attached image to show what I have done so far, and the file names which need explaining ...
WRnewSite_01.jpg
WRnewSite_01.jpg (113.03 KiB) Viewed 374 times
Thanks again for your help.
Cheers,
Phil.
User avatar
wriedmann
Posts: 3765
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

Hi Phil,

yes, I have seen: this is a LOT of material! (and was a lot of work of course)

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
User avatar
Phil Hepburn
Posts: 743
Joined: Sun Sep 11, 2016 2:16 pm

The X# Documentation Project

Post by Phil Hepburn »

Ten years worth of work and that is without too many breaks ;-0)

I won't be uploading much more !

I hope the size does not cause an issue !?

Let me know if it does.

I used to have all these up on my 'ClickStart' website.

Best regards,
Phil.
User avatar
wriedmann
Posts: 3765
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

Hi Phil,

no problem at all. The server has about 100 GB of (SSD) space, and therefore you are far from any limit. Space does not cost nothing these days....

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
Fab64
Posts: 63
Joined: Mon Nov 23, 2015 12:26 pm

The X# Documentation Project

Post by Fab64 »

Hi Phil and Wolfgang,

this is very interesting.
But is it a public or private resource?

I tried to download but only ClickStartXSharp194.chm is downloadable; for all the others from the following error message:

<<Forbidden

You do not have permission to access /ReportsNPrinting_81b.chm on this server.
Apache / 2.4.10 (Debian) Server at enotes.xsharp.it Port 80 >>

Fabrizio
Post Reply