The X# Documentation Project

This forum is meant for anything you would like to share with other visitors
Post Reply
User avatar
wriedmann
Posts: 3655
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

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
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
Terry
Posts: 306
Joined: Wed Jan 03, 2018 11:58 am

The X# Documentation Project

Post by Terry »

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
User avatar
wriedmann
Posts: 3655
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

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
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
FFF
Posts: 1532
Joined: Fri Sep 25, 2015 4:52 pm
Location: Germany

The X# Documentation Project

Post by FFF »

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

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

Regards
Karl
Regards
Karl
(on Win8.1/64, Xide32 2.19, X#2.19.0.2.)
User avatar
Phil Hepburn
Posts: 743
Joined: Sun Sep 11, 2016 2:16 pm

The X# Documentation Project

Post by Phil Hepburn »

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.

https://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.
XSreportingSections_01.jpg
XSreportingSections_01.jpg (158.22 KiB) Viewed 313 times
XSreportingSections_02.jpg
XSreportingSections_02.jpg (115.27 KiB) Viewed 313 times
Regards to Wolfgang and all.
User avatar
wriedmann
Posts: 3655
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

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 http://enotes.xsharp.it or some other subdomain.

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 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.
User avatar
wriedmann
Posts: 3655
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

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
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 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.
User avatar
wriedmann
Posts: 3655
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

The X# Documentation Project

Post by wriedmann »

Hi Phil,

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

enotes.xsharp.it

Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
Post Reply