fbpx
Welcome, Guest
Username: Password: Remember me

TOPIC: The X# Documentation Project

The X# Documentation Project 1 year 4 months ago #3734

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
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
Wolfgang Riedmann
Meran, South Tyrol, Italy
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3735

  Terry's Avatar Terry Offline Posts: 127
Hi Wolfgang

As someone who went off on a C# route some time ago and is now back looking at X#
I think this will be very useful.

Terry

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3736

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
Hi Terry,

yes, I hope so. Therefore I have spent a lot of time into this, and I plan to add at least two topics every week (if the project has some use, of course).

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3737

  FFF's Avatar FFF Away Posts: 577

Wolfgang Riedmann wrote: ...(if the project has some use, of course).

Wolfgang

Certainly it has! Great idea, Wolfgang - very commendable initiative.

Regards
Karl

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3738

  Phil Hepburn's Avatar Phil Hepburn Offline Posts: 742
Good morning Wolfgang,

Yes, a VERY worthwhile project - GOOD LUCK !!!

This is a HUGE undertaking, and as you know, most guys want everything 'now' :lol:

Meanwhile for you and anyone else, I will continue to add material to my 'ClickStartXSharp' eNotes that I work on continually - for many, many, months to date (years ?).

I am currently adding the Report creation and printing sections, some of which I will show and discuss in Cologne. Here is the 'OneDrive' link to the version as of last night.

1drv.ms/f/s!AiCBl-gBWjY9hcxoOaI3domPJifO4g

The link should work even when I update the version of the file to a newer one.

The best way to use the CHM file is to do Searches on it - I do this for myself, quite regularly, as I need to be reminded of syntax and other related stuff for getting code to work for me.

Feel free to use anything from the eNotes that you like.

Oh! should have said, one aspect that ClickStartXSharp does address throughout, is the way to use Visual Studio with X# development - and once again this is something that many guys will need at some time. Hence I have included hundreds of VS related images, and even some XAML script images where it makes sense.

Once again good luck, and thanks.
Cheers,
Phil.

P.S. one way my eNotes CHM file can help is that it is available when no internet connection is available to X# guys.

Attached images show the detailed folder structure of what is currently available in the eNotes on Reporting - there is still much more to add, as the topic is a very complex one.





Regards to Wolfgang and all.
Attachments:

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3739

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
Hi Phil,

yes, I know that this is a big undertaking, and I hope to not remain alone on this project.

Unfortunately, I need to make my living with my work, and so I can write down only what I know and what I use, but don't have the time to research things I will never need.

So your work and mine are completely different.... It would be stupid write the same things or spend the time on the same researches.

And since I'm working most of the time with XIDE, I cannot write topics about Visual Studio. But I try to write the samples directly as code to the topic itself.

And whenever I copy a topic from a forums thread, I will ask before... So for sure some of your knowledge will also be copied there, but only if you agree.

And as I wrote before: I can give you a home for your notes so you don't need to put them on some difficult to remember OneDrive address, maybe enotes.xsharp.it or some other subdomain.

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3740

  Phil Hepburn's Avatar Phil Hepburn Offline Posts: 742
Hi Wolfgang,

I totally agree - a job for more than one, even MANY !!! Or even a few hundred 'cloned' Wolfgangs ;-0)

What you suggest sounds sensible to me.

If you make the eNotes sub-domain as you suggest, would I be able to just send your the latest CHM file from my office PC and you put it up on your server - will it be as easy as that ? I don't really need it to be any more difficult than that at this end of the operation.

Can I send you the version 194 to try out, sometime soon ? Obviously we would publish it without the version number - do you agree ?

Please - don't ask me for permission to use any code, or other stuff from my eNotes, feel free to use whatever helps the X# Forum. I am making my eNotes open to all public interest and general use etc.. My mission is to help Robert and the Team as much as I can - they have helped me greatly over the years.

Can you use the OneDrive link I sent earlier, to get the CHM file as a test to placing it on your server ?

Let me know how I can help you in any way I am able.

Best regards,
Phil.
Wales, UK.

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3741

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
Hi Phil,

I will prepare a webspace on a server together with a DNS entry and send you the FTP credentials, so you can put on this server what you like.
I can also prepare a small PHP file that shows what files are present on this space, if you like.
I'll contact you in the evening when I'm back in my office.

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3742

  Phil Hepburn's Avatar Phil Hepburn Offline Posts: 742
Thanks a lot Wolfgang,

I have used FTP transfers in the past for maintaining my previous websites.

Just give me the instructions and I will do my best to follow.

No rush however, plenty to do here ;-0)

Cheers,
Phil.

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3747

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
Hi Phil,

the webspace is available and your latest eNote is uploaded there:

enotes.xsharp.it

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3748

  rjpajaron's Avatar rjpajaron Offline Posts: 191
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
--

Rene Pajaron

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3749

  rjpajaron's Avatar rjpajaron Offline Posts: 191

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
--

Rene Pajaron

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3750

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
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
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3751

  Phil Hepburn's Avatar Phil Hepburn Offline Posts: 742
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.

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3752

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
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
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3762

  Phil Hepburn's Avatar Phil Hepburn Offline Posts: 742
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 ...



Thanks again for your help.
Cheers,
Phil.
Attachments:

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3763

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
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
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3764

  Phil Hepburn's Avatar Phil Hepburn Offline Posts: 742
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.

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3765

  wriedmann's Avatar Topic Author wriedmann Away Posts: 1573
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
This email address is being protected from spambots. You need JavaScript enabled to view it.
www.riedmann.it - docs.xsharp.it

Please Log in or Create an account to join the conversation.

The X# Documentation Project 1 year 4 months ago #3766

  Fab64's Avatar Fab64 Offline Posts: 53
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

Please Log in or Create an account to join the conversation.