Re: [Mono-dev] MonoDoc editor - GSoC 2012
Hey Rauf, Rather than a GUI toolkit, the idea is more to have a common framework that concrete GUI editor can use to implement most editing operation on documentation. For instance, you would have to implement a "common overload edition"-operation which will take the modification for one method and try to apply it to the other overload of the method if any. If you think in a model-view-controller way, you would basically be implementing the controller mainly (with modification to the model, i.e. monodoc.dll, as necessary) and one view using it. -- Jérémie Laval http://neteril.org On Sun, Apr 1, 2012 at 5:43 PM, Rauf Butt wrote: > Dear Team Mono, > > > I am very excited to contribute in open source community through the > platform of GSoC 2012. Last year, I contributed "Debugger Visualizers" to > MonoDevelop (MD) and looking forward to work this year as well. > > > > I am formalising the proposal for "Awesome MonoDoc Editor". I am writing > you to let you know my understanding of the project and I would like your > feedback on it. My understanding of the requirements is as follows: > > > > 1. A C# GUI toolkit to be used as an independent editor component for > MonoDoc and NOT as an addin. > > 2. The code shall be well structured, keeping in mind the future > portability of the toolkit. > > 2. Atleast one front-end GUI that will implement the newly developed GUI > toolkit. > > > > I would be grateful if you could please comment or share some pointers to > start working? > > > Looking forward! > > > Regards, > > > > Rauf > > Regent's College London > > ___ > Mono-devel-list mailing list > Mono-devel-list@lists.ximian.com > http://lists.ximian.com/mailman/listinfo/mono-devel-list > > ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] monodoc
On Mon, 2008-03-03 at 08:32 -0800, Daniel Morgan wrote: > Does monodoc and the monodocer tools currently work on > Windows? Yes. They're also included with the Mono Windows download. > If it does, what do I need to do to create docs for an > assembly, such as, System.Data.OracleClient? http://www.mono-project.com/Monodocer > I haven't had too much success with these tools in the > past. > > And with the results, how do i get it to work in > monodoc? http://www.mono-project.com/Assembler > And how do I contribute the results to the mono > project? If you already have a svn account, you could just `svn add` the contents into the monodoc/class directory: http://anonsvn.mono-project.com/source/trunk/monodoc/class/ Otherwise, you'll need to create a .tar.gz/.zip file and send it to the list. - Jon ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc patches
Has anyone had a chance to look at these? No rush, of course. Thanks, Kevin On 3/18/07, Kevin Reay <[EMAIL PROTECTED]> wrote: > Hi all, > > I've attached two patches relating to monodoc; one affecting the > docbrowser, and the other affecting the monodoc engine. > > The first one (for the docbrowser) fixes a bug where ctrl-clicking a > link would cause a crash (due to AddTab() affecting the current > CurrentTab.html.Url variable). Also included are a bunch of changes, > tweaks and minor bugfixes to make the browser more HIG compliant and > comfortable to use (addition of cut functionality, correct icons in > the menus, spelling standardization, ...). > > The second one fixes some spelling and grammar mistakes on the main > documentation HTML page. It also corrects a reference to the new > upload contributions menu. > > Thanks, > Kevin > > > http://www.explodingrobot.com/mono/docbrowser.patch2.txt > http://www.explodingrobot.com/mono/monodoc.patch1.txt > > ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc patch
Hey! > Also, I uploaded to updates to the class doc. I'm just wondering if > anyone has had a chance to read them over. I'd like to know if I > should continue documenting things in that style. I got them, I just need to review them. > Finally, I'm hoping to add some new contributor features (thus the > creation of the Contributing menu) and would like anyones opinion on > whether the creation of a small list window to display the > contributions pending for upload would be something people would want. > It is something I would use. It sounds useful, but I think that we need a couple of improvements in general to Monodoc to make contributions more useful. I think that there are a couple of things that could improve things: * A WYSIWYG editor. * Maybe a "live" connection to get documentation updates, so when something is documented any consumer of Monodoc would be able to get the data. We also need someone that can act as an editor and can help me with the reviews of all the pending contributions. We have many pending contributions that I have not accepted because for each one, I have to review that the contribution is not a direct copy of MS documentation, so I tend to put those off. Miguel. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc patch
Hey Kevin, Thanks a lot for your patch! It is now on SVN. Miguel. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc engine crashes um uncompressed help, stopping MD code completion
Joshua, It happens when some, probably newer, methods to extract pieces of xml are called and the base class assumes a zipfile is present. As I said, when MD is regenerating the code completion database it uses such functionality. If it is something to keep, probably some refactoring of the inheritance tree is in order, maybe spawning to middle classes for zipfile/ uncompressed families of leaf classes. Can't dig in it just now... Sorry On 2/7/07, Joshua Tauberer <[EMAIL PROTECTED]> wrote: > Miguel de Icaza wrote: > >> Don't know what is best for monodoc's engine, to drop uncompressed > >> support altogether or to correct the subclass to override the needed > >> methods. Any bets? > > > > Drop uncompressed support. I did not even know we had that. > > This is my hack that underlies 'monodoc --edit path' right? I use that > all the time to edit my own documentation, rather than using a text > editor, so I'd rather you didn't drop it. I've never had that crash for > me except for when monodocer left the index.xml file in an inconsistent > state. > > -- > - Josh Tauberer > > http://razor.occams.info > > "Yields falsehood when preceded by its quotation! Yields > falsehood when preceded by its quotation!" Achilles to > Tortoise (in "Gödel, Escher, Bach" by Douglas Hofstadter) > -- Rafael "Monoman" Teixeira --- "The reasonable man adapts himself to the world; the unreasonable one persists in trying to adapt the world to himself. Therefore all progress depends on the unreasonable man." George Bernard Shaw ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc engine crashes um uncompressed help, stopping MD code completion
Hello, > >> Don't know what is best for monodoc's engine, to drop uncompressed > >> support altogether or to correct the subclass to override the needed > >> methods. Any bets? > > > > Drop uncompressed support. I did not even know we had that. > > This is my hack that underlies 'monodoc --edit path' right? I use that > all the time to edit my own documentation, rather than using a text > editor, so I'd rather you didn't drop it. I've never had that crash for > me except for when monodocer left the index.xml file in an inconsistent > state. Oh. I guess we should keep it, and not have folks depend on that on their trees. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc engine crashes um uncompressed help, stopping MD code completion
Miguel de Icaza wrote: >> Don't know what is best for monodoc's engine, to drop uncompressed >> support altogether or to correct the subclass to override the needed >> methods. Any bets? > > Drop uncompressed support. I did not even know we had that. This is my hack that underlies 'monodoc --edit path' right? I use that all the time to edit my own documentation, rather than using a text editor, so I'd rather you didn't drop it. I've never had that crash for me except for when monodocer left the index.xml file in an inconsistent state. -- - Josh Tauberer http://razor.occams.info "Yields falsehood when preceded by its quotation! Yields falsehood when preceded by its quotation!" Achilles to Tortoise (in "Gödel, Escher, Bach" by Douglas Hofstadter) ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc engine crashes um uncompressed help, stopping MD code completion
Hello, > Don't know what is best for monodoc's engine, to drop uncompressed > support altogether or to correct the subclass to override the needed > methods. Any bets? Drop uncompressed support. I did not even know we had that. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] MonoDoc Win32 - Upload Contributions
Can you at least add the data providers? I can contribute docs for these. Remember, I am the maintainer of the database pages on the mono wiki. And if possible, I wonder if there is a way to take current documentation for Npgsql, ByteFX.Data/MySql.Data, and FirebirdSql.Data and somehow convert it to Monodoc's format. Not sure how to accomplish this. I'm sure I would need permission from the authors of those docs to do it. Having them in monodoc will allow mono application programmers to _know_ that the library _exists_ and allows them to see what members are available instead of having to read the source or use monop. So, please add these. Joshua probably would be the best to write monodoc docs about the SQL Lite provider since he's the current maintainer. Oh, can we add docs for libraries that do not come with Mono? Such as, MySql.Data from MySQL AB. As for the ProviderFactory in Mono.Data, what is missing? In the future, it possibly could be deprecated if the majority of Mono users have moved to ADO.NET 2.0 which has built-in provider factory support. However, I am still doing only ADO.NET 1.1. BTW, if Upload Contributions is fixed on Monodoc/win32, you will have more contributions from people. See bug 77684. Bug 77955 is duplicate of 77684. Miguel de Icaza <[EMAIL PROTECTED]> wrote: Hello,> I can edit content, but I can not upload.What is the erro that you get?> Can someone add these please?> > These assemblies include:> System.Data.OracleClient> Mono.Data.SybaseClient> Mono.Data.SqliteClient> Npgsql> ByteFX.Data that has ByteFX.Data.MySqlClient> System.Data.Odbc found in System.Data> IBM.Data.DB2> Mono.Data> Mono.Http> System.Windows.FormsI added Windows.Forms recently;Mono.Http is really an internal classMono.Data is unfinished as far as I can tell.For the other ones, I can add the stubs, am just afraid that we mightend up with a lot of stubs and no content, which is why I have notstubbed them out.I think you can email your ~/.config/monodoc/changeset.xml and I canapply those changes manually to the repository.Miguel.___Mono-devel-list mailing listMono-devel-list@lists.ximian.comhttp://lists.ximian.com/mailman/listinfo/mono-devel-list How low will we go? Check out Yahoo! Messengers low PC-to-Phone call rates.___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] MonoDoc Win32 - Upload Contributions
Hello, > I can edit content, but I can not upload. What is the erro that you get? > Can someone add these please? > > These assemblies include: > System.Data.OracleClient > Mono.Data.SybaseClient > Mono.Data.SqliteClient > Npgsql > ByteFX.Data that has ByteFX.Data.MySqlClient > System.Data.Odbc found in System.Data > IBM.Data.DB2 > Mono.Data > Mono.Http > System.Windows.Forms I added Windows.Forms recently; Mono.Http is really an internal class Mono.Data is unfinished as far as I can tell. For the other ones, I can add the stubs, am just afraid that we might end up with a lot of stubs and no content, which is why I have not stubbed them out. I think you can email your ~/.config/monodoc/changeset.xml and I can apply those changes manually to the repository. Miguel. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc
Hello, > I think for this, we should add some attributes to the member elements > in the docs, something like InNET1_0 for members in Fx 1.0, InNET1_1, > for members in Fx 1.1, etc. Would this be an options? Miguel? > > When it would be, we would need to scan the complete documentation, > and add those attributes. Maybe we should make a one time conversion > process which imports Fx 1.0, Fx 1.1, Fx 2.0 (i don't know if that's > smart yet), etc classes. > > Please give your thoughts about this. I do not think we need a "profile switcher", it might be confusing to people that if they use that and leave it on accidentally they never see the new stuff. So a label that says "Available since: " might be all that we need. And that information is already being used/rendered by Gtk#. Miguel. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc
I think for this, we should add some attributes to the member elements in the docs, something like InNET1_0 for members in Fx 1.0, InNET1_1, for members in Fx 1.1, etc. Would this be an options? Miguel? When it would be, we would need to scan the complete documentation, and add those attributes. Maybe we should make a one time conversion process which imports Fx 1.0, Fx 1.1, Fx 2.0 (i don't know if that's smart yet), etc classes. Please give your thoughts about this. On 10/3/05, Alexandre Miguel Pedro Gomes <[EMAIL PROTECTED]> wrote: Monodoc would need a "profile chooser" or something like that to switch between 1.x and 2.0 profile, right? Any plans on those things? Btw anyone knows why the C# specification appears without newlines? On 9/30/05, Miguel de Icaza < [EMAIL PROTECTED] > wrote: Hello,> When will monodoc be ready for .NET 2.0 classes? (ie, when will it > also allow to document generics)We will have to wait for someone to contribute the necessary code to cope with this. I have not had much time to look into this issue.What needs to be done is:* Look at the new ECMA XML documentation from ECMA and evaluate how we could bring those changes into our documentation. * Someone would have to port the new docs nonetheless.* Someone would have to architect the changes to the monodoc engine to do so.The right place to discuss this is the mono-docs-list. That being said, if you can not wait to write some documentation, we have a *lot* of stuff in the 1.x profile that needs documentation.Considering that 2.x stuff wont be 100% supported for a while, maybe it would be best to contribute to the 1.x effort.___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.comhttp://lists.ximian.com/mailman/listinfo/mono-devel-list -- Alexandre Gomes, Portugal ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] monodoc os x
Umm...I would say that it is looking for a font on your system that it could not find and doesn't know what to do (probably one of the Mac standard stuff, but it might be in the additional font package). Check to see if Verdana is in your font chooser. If that's not the problem, then hopefully someone else can help (I don't have monodoc installed). On Oct 3, 2005, at 9:21 PM, Roberto Carvajal wrote: Hey there! I'm trying to get monodoc and monodevelop running on Tiger and I can't figure out how to solve this particular problem: roberto$ monodoc (:918): Pango-WARNING **: Cannot open font file for font Verdana 9.591796875 (:918): Pango-WARNING **: Cannot open fallback font, nothing to do I installed mono and all gtk related stuff with fink unstable.. Any idea on how to solve this? Thanks! -- Roberto Carvajal LOKO IT Services [EMAIL PROTECTED] http://roberto.entodaspartes.org/blog ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc
Monodoc would need a "profile chooser" or something like that to switch between 1.x and 2.0 profile, right? Any plans on those things? Btw anyone knows why the C# specification appears without newlines?On 9/30/05, Miguel de Icaza <[EMAIL PROTECTED] > wrote:Hello,> When will monodoc be ready for .NET 2.0 classes? (ie, when will it > also allow to document generics)We will have to wait for someone to contribute the necessary code tocope with this. I have not had much time to look into this issue.What needs to be done is: * Look at the new ECMA XML documentation from ECMA and evaluate how we could bring those changes into our documentation.* Someone would have to port the new docs nonetheless. * Someone would have to architect the changes to the monodoc engine to do so.The right place to discuss this is the mono-docs-list.That being said, if you can not wait to write some documentation, we have a *lot* of stuff in the 1.x profile that needs documentation.Considering that 2.x stuff wont be 100% supported for a while, maybe itwould be best to contribute to the 1.x effort.___ Mono-devel-list mailing listMono-devel-list@lists.ximian.comhttp://lists.ximian.com/mailman/listinfo/mono-devel-list -- Alexandre Gomes, Portugal ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc
you should take a look at this: http://people.mosaix.net/chris/tutorials/monodoc/monodoc-tutorial.html and if you still have questions please post on to the monodoc mailing list only. No need to cross post. - raf On Mon, 2005-10-03 at 17:38 +0200, Matthijs ter Woord wrote: > Is there any special format needed? (IE, ecma xml docs etc) If so, could > anyone point me to it? > > > Regards, > > Matthijs ter Woord > > > > > - Original Message - > From: "Miguel de Icaza" <[EMAIL PROTECTED]> > To: "Matthijs ter Woord" <[EMAIL PROTECTED]>; > > Cc: <[EMAIL PROTECTED]> > Sent: Friday, September 30, 2005 4:20 AM > Subject: Re: [Mono-dev] Monodoc > > > > Hello, > > > > > When will monodoc be ready for .NET 2.0 classes? (ie, when will it > > > also allow to document generics) > > > > We will have to wait for someone to contribute the necessary code to > > cope with this. I have not had much time to look into this issue. > > > > What needs to be done is: > > > > * Look at the new ECMA XML documentation from ECMA and evaluate > > how we could bring those changes into our documentation. > > > > * Someone would have to port the new docs nonetheless. > > > > * Someone would have to architect the changes to the monodoc > > engine to do so. > > > > The right place to discuss this is the mono-docs-list. > > > > That being said, if you can not wait to write some documentation, we > > have a *lot* of stuff in the 1.x profile that needs documentation. > > Considering that 2.x stuff wont be 100% supported for a while, maybe it > > would be best to contribute to the 1.x effort. > > > > > ___ > Mono-devel-list mailing list > Mono-devel-list@lists.ximian.com > http://lists.ximian.com/mailman/listinfo/mono-devel-list > ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc
Is there any special format needed? (IE, ecma xml docs etc) If so, could anyone point me to it? Regards, Matthijs ter Woord - Original Message - From: "Miguel de Icaza" <[EMAIL PROTECTED]> To: "Matthijs ter Woord" <[EMAIL PROTECTED]>; Cc: <[EMAIL PROTECTED]> Sent: Friday, September 30, 2005 4:20 AM Subject: Re: [Mono-dev] Monodoc > Hello, > > > When will monodoc be ready for .NET 2.0 classes? (ie, when will it > > also allow to document generics) > > We will have to wait for someone to contribute the necessary code to > cope with this. I have not had much time to look into this issue. > > What needs to be done is: > > * Look at the new ECMA XML documentation from ECMA and evaluate > how we could bring those changes into our documentation. > > * Someone would have to port the new docs nonetheless. > > * Someone would have to architect the changes to the monodoc > engine to do so. > > The right place to discuss this is the mono-docs-list. > > That being said, if you can not wait to write some documentation, we > have a *lot* of stuff in the 1.x profile that needs documentation. > Considering that 2.x stuff wont be 100% supported for a while, maybe it > would be best to contribute to the 1.x effort. > ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
Re: [Mono-dev] Monodoc
Hello, > When will monodoc be ready for .NET 2.0 classes? (ie, when will it > also allow to document generics) We will have to wait for someone to contribute the necessary code to cope with this. I have not had much time to look into this issue. What needs to be done is: * Look at the new ECMA XML documentation from ECMA and evaluate how we could bring those changes into our documentation. * Someone would have to port the new docs nonetheless. * Someone would have to architect the changes to the monodoc engine to do so. The right place to discuss this is the mono-docs-list. That being said, if you can not wait to write some documentation, we have a *lot* of stuff in the 1.x profile that needs documentation. Considering that 2.x stuff wont be 100% supported for a while, maybe it would be best to contribute to the 1.x effort. ___ Mono-devel-list mailing list Mono-devel-list@lists.ximian.com http://lists.ximian.com/mailman/listinfo/mono-devel-list
