[Mono-docs-list] Re: A first draft table of contents for the 'Start here' mono documentation, comments please

[Martin Willemoes Hansen]

On Wed, 2002-12-18 at 02:12, Felix Faassen wrote:
> Here is my first version of the table of contents in regards to the "Start
> here" doc or Redbook or whatever
> we want to call, what about refering to a manual ;-) mzz does sounds a bit
> cocky heheh...anyway
> 
> Some notes on the TOC. I've tried to incorperate some topics I read on the
> site, some topics which where
> listed in the TOC proposed in the posting of september. I've left out the C#
> language stuff because I think
> that's really out of the scope of this document.
> Furthermore I lend some of the topics which are included in Martin's
> tutorial.
> 
> My main goal was to create a clear division of topics. Some chapters have
> paragraphs defined. I haven't started
> on actually defining all (sub)-paragraphs.
> 
> Okay here it is. Please let me know what everybody thinks about this TOC
> 
> hit me :-)
> 
> 
> ----------------------8<-------------------------
> 
> Contents
> 	this toc. Toc will be generated of course ;-)
> Preface
> 	Outline of this document, how it's setup etc.
> 
> PART 1	INTRODUCTION
> 
> 	CHAPTER 1 MONO
> 
> 		1.1 What is .NET?
> 		1.2 What is Mono?
> 		1.3 An introduction to Mono
> 
> 	CHAPTER 2 ARCHITECTURE
> 
> 		2.1 .NET Framework Architecture
> 		2.2 Mono Implementation
> 		2.3 Mono and the .NET Framework,a comparison
> 
> 	CHAPTER 3 TOOLS OVERVIEW
> 		3.1 The Mono Runtime
> 		3.2 C# Compiler
> 		3.3 VB Compiler
> 		3.4 Mono IL Disassmbler
> 		...do I forget someting??
> 
> PART 2	INSTALLING THE MONO DEVELOPMENT ENVIRONMENT
> 
> 	CHAPTER 4 GETTING STARTED
> 		4.1 Installation overview
> 		4.2 Installation considerations
> 		4.3 Choosing an Integrated Development Environment (IDE)
> 
> 	CHAPTER 5 INSTALLING MONO ON LINUX BASED SYSTEMS
> 		5.1 Getting the files
> 		5.2 Compiling Mono
> 		5.3 Installing Mono
> 
> 	CHAPTER 6 INSTALLING MONO ON WINDOWS BASED SYSTEMS
> 		6.1 Getting the files
> 		6.2 Compiling Mono
> 		6.3 Installing Mono
> 
> 	CHAPTER 7 CONFIGURING THE IDE
> 		7.1	Emacs
> 		7.2 Eclipse
> 		7.3 #develop
> 
> PART 3	USING THE MONO DEVELOPMENT ENVIRONMENT
> 
> 	CHAPTER 8 Runtime Environment
> 
> 	CHAPTER 9 C# Compiler
> 		9.1 Introduction
> 		9.2 Command-line options
> 		9.3 Compiler errors
> 		9.4 Important notes
> 
> 	CHAPTER 10 VB Compiler aka mBas
> 		10.1 Introduction
> 		10.2 Command-line options
> 		10.3 Compiler errors
> 		10.4 Important notes
> 
> 	CHAPTER 11 MonoDoc XML
> 		11.1 Introduction
> 		11.2 MonoDoc XML Tags
> 		11.3 Definition and Examples
> 		11.4 Using the MonoDoc toolset (monograph, xs etc.)
> 			[remark: This has been taken from
> http://www.go-mono.com/monodoc-xml.html]
> 
> 
> PART 4	DEVELOPING APPLICATIONS WITH MONO
> 
> 	CHAPTER 12 Cross Platform Development
> 	CHAPTER 13 GUI programming
> 		13.1 Introduction
> 		13.2 GTK#
> 		13.3 Windows Forms
> 	CHAPTER 14 ADO.NET in Mono
> 
> 	CHAPTER 15 ASP.NET in Mono
> 
> 	CHAPTER 16 Creating Web Services
> 
> 	CHAPTER 17 Threading
> 
> 	CHAPTER 18 Remoting support in Mono
> 
> 	CHAPTER 19 Component Interoperability
> 		19.1 Windows COM
> 		19.2 Gnome Bonobo
> 
> APPENDIX
> A	API REFERENCE
> B	CODE SAMPLES USED IN THIS DOCUMENT
> C   TUTORIALS REFERENCES
> C	WEB RESOURCES
> D	RECOMMENDED READING
> E	CREDITS
> 
> ----------------8<------------------
> 
> Take care,
> 
> 
> Felix

I think we have a bit of overlap between this manual and the gnome.net
tutorial.
Have you guys read the java tutorial? That was one of my inspirations
for the gnome.net tutorial original the mono tutorial.

What do you think of a merge (renaming gnome.net tutorial --> mono
tutorial? or a split, like only keeping gnome stuff in the gnome.net
tutorial.

If it was merged it would be a complete first place to go to program
with mono on linux/gnome or maybe pragmatic programming with
win32/mac/linux on gnome, qt, win32.

But with a clear split, so we have generel stuff first, then a win32
section a linux section a gnome section etc. Could be nice for people
only working on one platform and know it good. Also for the documenter,
he can concentrate on the specific section he know.
-- 
Martin Willemoes Hansen

--------------------------------------------------------
E-Mail	mwh@sysrq.dk	Website	mwh.sysrq.dk
IRC     MWH, freenode.net	
--------------------------------------------------------