Ideas - Revision history

Awiebe at 21:16, 16 July 2012

2012-07-16T21:16:25Z

Cbv: removed unbalanced nowiki

2007-01-02T15:28:17Z

removed unbalanced nowiki

Rfm: /* Autogsdoc and wiki syntax */

2006-11-02T14:52:31Z

Autogsdoc and wiki syntax

Cbv: /* Help Center and Librarian In One Application */ Link to MyLibrary.app

2006-10-30T00:33:33Z

Help Center and Librarian In One Application: Link to MyLibrary.app

Madleser: link to Wish list, add mylibrary and appwrapper ideas

2006-10-02T15:18:26Z

link to Wish list, add mylibrary and appwrapper ideas

Madleser: updated

2006-10-02T14:17:16Z

updated

Frederik at 18:34, 27 February 2005

2005-02-27T18:34:27Z

Frederik: simpler markup?

2005-02-27T18:33:09Z

simpler markup?

Stefan Urbanek: /* Autogsdoc and wiki syntax */

2005-02-26T20:51:07Z

Autogsdoc and wiki syntax

Stefan Urbanek: /* Autogsdoc and wiki syntax */

2005-02-26T20:46:16Z

Autogsdoc and wiki syntax

← Older revision		Revision as of 21:16, 16 July 2012
Line 68:		Line 68:

	A script of some sort that, once run, collects information about the user's preferences. Is Gnome, KDE or Windows running? Which apps can handle which MIME types? Which icons do they have? This information is saved in separate application bundles and make_services is run. Documents for which there is no GNUstep app installed will fallback on Gnome/KDE/Windows alternatives and for other files, the user has the choice. Generated App bundles should be flagged to make updating of apps easier, e.g. when the user installs other apps.		A script of some sort that, once run, collects information about the user's preferences. Is Gnome, KDE or Windows running? Which apps can handle which MIME types? Which icons do they have? This information is saved in separate application bundles and make_services is run. Documents for which there is no GNUstep app installed will fallback on Gnome/KDE/Windows alternatives and for other files, the user has the choice. Generated App bundles should be flagged to make updating of apps easier, e.g. when the user installs other apps.
		+
		+	==XIB codec using NSKeyedArchiver==
		+	Here is a [[XIB]] file I have begun decodeing, it really is quite a simple format, what is more important is insuring that the NSObjects encode and decode themselves using the correct attribute names.

← Older revision		Revision as of 15:28, 2 January 2007
Line 13:		Line 13:
	<nowiki>The requirement of specificaly marking instance variables should be reconsidered. Italics should be used instead. Firstly, it is already common. Secondly, there is no need to preserve an information in the documentation that specified word is a function argument or an instance variable. The information is obvious to the reader from context and already used different font.</nowiki>		<nowiki>The requirement of specificaly marking instance variables should be reconsidered. Italics should be used instead. Firstly, it is already common. Secondly, there is no need to preserve an information in the documentation that specified word is a function argument or an instance variable. The information is obvious to the reader from context and already used different font.</nowiki>

−	~~</nowiki>~~

	XML is a bit complicated for such simple task as documentation.		XML is a bit complicated for such simple task as documentation.

← Older revision		Revision as of 14:52, 2 November 2006
Line 18:		Line 18:

	I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html] --[[User:Frederik\|Frederik]] 19:34, 27 Feb 2005 (CET)		I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html] --[[User:Frederik\|Frederik]] 19:34, 27 Feb 2005 (CET)
		+
		+	=== Current actual documentation setup ===
		+
		+	The above seems to be based on a misunderstanding of how GNUstep documentation is generated and what the tools do.
		+
		+	The XML documentation language (gsdoc) is an intermediate format generated by autogsdoc, and from which standard tools like xslt can be used to generate other documentation formats. The actual markup used by autogsdoc is extremely simple.
		+
		+	eg.
		+
		+	To cross reference the NSArray class you write [NSArray] (ie class name within square brackets).
		+
		+	To reference a class method you might write +arrayWithobjects: (ie the method name prefixed with a +).
		+
		+	To reference an instance method you might write -descriptionWithLocale: (ie the method name prefixed with -).
		+
		+	To reference a method in a particular class you might write [NSDictionary-description] (class name and method both within square brackets).
		+
		+	To reference a function you write its name followed by brackets (eg. NSLog())
		+
		+	Users can also embed gsdoc markup (though it's rarely needed), typically for html-style list or text formatting.

	=== Doxygen ===		=== Doxygen ===

@@ Line 44: / Line 44: @@
 == Help Center and Librarian In One Application ==
-Use Yen-Ju Chen's MyLibrary (http://unix.freshmeat.net/projects/mylibrary/ -- currently down?) as the help center and the answer to Nextstep's Librarian. Applications install their help files where MyLibrary can find and index them and taadaa, you have a note keeping, help storing and things-of-your-choice indexing application all in one! The only thing that would be even better is an enhanced Spotlight clone to do all of the above on all platforms.
+Use Yen-Ju Chen's [[MyLibrary.app]] as the help center and the answer to Nextstep's Librarian. Applications install their help files where MyLibrary can find and index them and taadaa, you have a note keeping, help storing and things-of-your-choice indexing application all in one! The only thing that would be even better is an enhanced Spotlight clone to do all of the above on all platforms.
 == Better integration into Gnome/KDE/Windows desktops: AppWrapper.app ==
 A script of some sort that, once run, collects information about the user's preferences. Is Gnome, KDE or Windows running?  Which apps can handle which MIME types?  Which icons do they have? This information is saved in separate application bundles and make_services is run.  Documents for which there is no GNUstep app installed will fallback on Gnome/KDE/Windows alternatives and for other files, the user has the choice. Generated App bundles should be flagged to make updating of apps easier, e.g. when the user installs other apps.

@@ Line 1: / Line 1: @@
 Everybody loves to tinker. Ideas on future development should go here.
 __TOC__
 == Autogsdoc and wiki syntax ==
@@ Line 39: / Line 41: @@
 Developers should focus on development and not mess with files. Synchronizing header files with source files is no fun, neither is having to jump around for documentation of different methods and such. See http://ide.roard.com/wakka.php?wiki=Goals for some brainstorming on this topic.

← Older revision		Revision as of 14:17, 2 October 2006
Line 1:		Line 1:
		+	Everybody loves to tinker. Ideas on future development should go here.
		+	__TOC__
	== Autogsdoc and wiki syntax ==		== Autogsdoc and wiki syntax ==

Line 14:		Line 16:

	I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html] --[[User:Frederik\|Frederik]] 19:34, 27 Feb 2005 (CET)		I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html] --[[User:Frederik\|Frederik]] 19:34, 27 Feb 2005 (CET)
		+
		+	=== Doxygen ===
		+
		+	It does most of the cross-referencing automatically and is way more powerful.
		+
		+	The SideStep (and Etoile?) people and libFoundation already use
		+	Doxygen. See http://libfoundation.opendarwin.org/docs/ for
		+	libFoundation. To see how the GNUstep source tree documentation looks
		+	like, first install Doxygen, then do:
		+
		+	cd /tmp
		+	svn co svn://svn.gna.org/svn/sidestep/trunk sidestep
		+	cd sidestep
		+	<edit Doxyfile.in -> replace "@DOTDIR@" by the path containing the dot
		+	tool. If you don't have graphviz installed, set HAVE_DOT to NO
		+	instead. You can also use 'doxywizard <file>' to configure stuff.>
		+	doxygen Doxyfile.in
		+
		+	and wait for it to finish (it generates no output except warnings). [[User:Madleser\|Madleser]] 16:17, 2 October 2006 (CEST)
		+
		+	== New Approach to a Code Editor ==
		+
		+	Developers should focus on development and not mess with files. Synchronizing header files with source files is no fun, neither is having to jump around for documentation of different methods and such. See http://ide.roard.com/wakka.php?wiki=Goals for some brainstorming on this topic.

← Older revision		Revision as of 18:34, 27 February 2005
Line 12:		Line 12:

	XML is a bit complicated for such simple task as documentation.		XML is a bit complicated for such simple task as documentation.
−	~~ack,~~ I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html]	+
		+	I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html] --[[User:Frederik\|Frederik]] 19:34, 27 Feb 2005 (CET)

← Older revision		Revision as of 18:33, 27 February 2005
Line 12:		Line 12:

	XML is a bit complicated for such simple task as documentation.		XML is a bit complicated for such simple task as documentation.
		+	ack, I'd suggest something like ruby's rdoc [http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html]

@@ Line 5: / Line 5: @@
 <nowiki>Italics should be marked by ''italics'', bold by '''bold''' (mediawiki) or by __bold__ (phpwiki)</nowiki>
-<nowiki> The references should be: [[Class:class_name]], [[Method:Class:methodName:]], [[ivar:ivarname]]</nowiki>
+<nowiki> The references should be: [[Class:class_name]], [[Method:Class:methodName:]], [[framework:framework name in local documentation namespace]]</nowiki>
 XML is a bit complicated for such simple task as documentation.