[Monodevelop-patches-list] r1463 - trunk/MonoDevelop/docs

commit-watcher at mono-cvs.ximian.com commit-watcher at mono-cvs.ximian.com
Wed Apr 14 21:15:33 EDT 2004


Author: jluke
Date: 2004-04-14 21:15:32 -0400 (Wed, 14 Apr 2004)
New Revision: 1463

Added:
   trunk/MonoDevelop/docs/Translations.html
Modified:
   trunk/MonoDevelop/docs/SourceMap.html
   trunk/MonoDevelop/docs/WritingAddIns.html
Log:
add and updates


Modified: trunk/MonoDevelop/docs/SourceMap.html
===================================================================
--- trunk/MonoDevelop/docs/SourceMap.html	2004-04-14 22:10:09 UTC (rev 1462)
+++ trunk/MonoDevelop/docs/SourceMap.html	2004-04-15 01:15:32 UTC (rev 1463)
@@ -106,6 +106,8 @@
 
     <h3>Credits and Errata</h3>
     <p>Send comments to <a href="mailto:jluke at cfl.rr.com">jluke at cfl.rr.com</a> or the <a href="mailto:monodevelop-list at lists.ximian.com">monodevelop mailing list</a>.</p>
-	<p>Last updated March 24, 2004</p>
+	<p><a href="http://opensource.org/licenses/mit-license.php">MIT License</a></p>
+	<p>Last updated April 14, 2004</p>
   </body>
 </html>
+

Added: trunk/MonoDevelop/docs/Translations.html
===================================================================
--- trunk/MonoDevelop/docs/Translations.html	2004-04-14 22:10:09 UTC (rev 1462)
+++ trunk/MonoDevelop/docs/Translations.html	2004-04-15 01:15:32 UTC (rev 1463)
@@ -0,0 +1,43 @@
+<html>
+  <head>
+    <title>Translations in MonoDevelop</title>
+  <head>
+  <body>
+    <h3>Introduction</h3>
+	<p>MonoDevelop has chosen to use gettext instead of resources
+	for translating into other languages.  This allows us to take
+	advantage of GNOME translators familiarity with gettext and 
+	other advantages.</p>
+	<h3>Developers</h3>
+	<p>Instead of using a string directly in your code, you just need
+	to pass it to gettext which returns the translated string to you.
+	<ol>
+	  <li>Remember to encase all user visible strings, like so:<br />
+	<code>GettextCatalog.GetString ("user visible string")</code><br />
+	<code>String.Format (GettextCatalog.GetString ("user visible string {0}"), variable)</code>
+	  </li>
+	  <li>Add files with these strings to MonoDevelop/po/POTFILES.in</li>
+	</ol>
+	</p>
+	<h3>Translators</h3>
+	<p>See <a href="http://www.gnome.org/i18n/">Gnome I18N</a> for
+	information about the GNOME translation project.  Much of that
+	material will also apply here.  In particular: <br />
+	<ul>
+      <li><a href="http://lcweb.loc.gov/standards/iso639-2/englangn.html">Language codes</a></li>
+      <li><a href="http://developer.gnome.org/projects/gtp/resources.html">Resources</a></li>
+	</ul>
+	<ol>
+	  <li>Create xx_XX.po (based on you Language code)</li>
+	  <li>Translate the strings</li>
+	  <li>add your language code to ALL_LINGUAS in configure.in</li>
+	  <li>test by running <code>LANG=xx_XX monodevelop</code></li>
+	</ol>
+	</p>
+	<h3>Credits, License, Errata</h3>
+	<p>Send comments to <a href="mailto:jluke at cfl.rr.com">jluke at cfl.rr.com</a> or the <a href="mailto:monodevelop-list at lists.ximian.com">monodevelop mailing list</a>.</p>
+	<p>Licensed under the <a href="http://opensource.org/licenses/mit-license.php">MIT License</a></p>
+    <p>Last updated April 14, 2004</p>
+  </body>
+</html>
+

Modified: trunk/MonoDevelop/docs/WritingAddIns.html
===================================================================
--- trunk/MonoDevelop/docs/WritingAddIns.html	2004-04-14 22:10:09 UTC (rev 1462)
+++ trunk/MonoDevelop/docs/WritingAddIns.html	2004-04-15 01:15:32 UTC (rev 1463)
@@ -14,10 +14,11 @@
     intended as a simple and quick overview.</p>
 
 	<h3>Terms</h3>
-	<p>AddIn - what other systems term a plugin, also used for the core
-	application.<br />
-	Pad - content area like the project browser or output pad. <br />
-	View - main content area, like the SourceEditor.<br />
+	<p><b>AddIn</b> - what many other systems refer to as a plugin. In this case the whole application is also a plugin<br />
+	<b>Pad</b> - content area like the project browser or output pad. <br />
+	<b>View</b> - main content area, like the SourceEditor.<br />
+	<b>Language binding</b> - compilation, execution, and project management for a programming language<br />
+	<b>Service</b> - reponsible for one part of the program, for example the MessageService is delegated the reponsiblity of displaying messages to the user.
     </p>
 
     <h3>AddIn assembly</h3>
@@ -36,6 +37,7 @@
 {
 	public class ExampleService : AbstractService
 	{
+		// Do stuff here
 	}
 }
 </pre>
@@ -53,13 +55,15 @@
 </pre>
 </p>
 
-    <h3>.addin file</h3>
+    <h3>.addin.xml file</h3>
+	<p><b>Note:</b> MonoDevelop had to change to .addin.xml extension for
+	using gettext in translations.  SharpDevelop uses .addin</p>
     <p>The addin file basically maps the "entry" points of your code
 	into the various parts of the IDE.  You specify services to load,
     append menus in a certain place, and virtually everything else.
 	Since the entire application is an AddIn there is no limit.
     It supports conditional directives and other advanced constructs.
-    In the following sample MonoDevelopNunit.addin file, you can see
+    In the following sample MonoDevelopNunit.addin.xml file, you can see
 	it specifies the name of the assembly to load, specifies a service
     to load into the /Workspace/Services node, two views and some menus.
     Last, it is important to note the class attribute that is used to
@@ -103,22 +107,28 @@
 </AddIn>
 	</xmp>
 
+	<h3>AddIn tree</h3>
+	<p>The various addins are loaded and merge into an AddInTree, which
+	is how the IDE knows what and where to load</p>
+
     <h3>AddIn xml format</h3>
 	<p>There is an AddIn.xsd file that specifies the required/optional
 	xml format. Perhaps someone would like to make a RelaxNG one also.
-	See data/resources/AddIn.xsd</p>
+	See <code>data/resources/AddIn.xsd</code></p>
 
     <h3>Building and installing</h3>
-    <p>We currently support both running in a self-contained build/
-    directly as well as installing to $(prefix)/lib/monodevelop so you
-    will want to make sure both your .addin file and .dll are placed
-    into the AddIn directory in both places.  Note: this this may change
+    <p>We currently support both running in a self-contained <code>build/</code>
+    directory as well as installing to <code>$(prefix)/lib/monodevelop</code> so you
+    will want to make sure both your .addin.xml file and .dll are placed
+    into the AddIn directory in both places.  <b>Note:</b> this this may change
     at some point in the future.</p>
 
 	<h3>Existing Examples</h3>
 <ul>
   <li>SourceEditor</li>
   <li>CSharpBinding</li>
+  <li>JavaBinding</li>
+  <li>NemerleBinding</li>
   <li>DebuggerAddin</li>
   <li>Monodoc</li>
   <li>StartPage (not fully ported)</li>
@@ -129,7 +139,9 @@
     <p>Although SharpDevelop and MonoDevelop currently use the same
     format this may not always be the case.  Also, while non-gui addins
     could possibly be reused, MonoDevelop and SharpDevelop use different
-    GUI toolkits that will likely prevent sharing many things.</p>
+    GUI toolkits that will likely prevent sharing many things. Any
+	suggestions on making sharing things as easy as possible would be
+	appreciated.</p>
 
     <h3>AddIn ideas</h3>
     <p>There are various things that would be nice to have implemented
@@ -146,8 +158,10 @@
   <li>Also, there are some additional things that SharpDevelop already has that could be ported to MonoDevelop.</li>
 </ul></p>
 
-	<h3>Credits and Errata</h3>
+	<h3>Credits, License, Errata</h3>
 	<p>Send comments to <a href="mailto:jluke at cfl.rr.com">jluke at cfl.rr.com</a> or the <a href="mailto:monodevelop-list at lists.ximian.com">monodevelop mailing list</a>.</p>
-    <p>Last updated March 24, 2004</p>
+	<p>Licensed under the <a href="http://opensource.org/licenses/mit-license.php">MIT License</a></p>
+    <p>Last updated April 14, 2004</p>
   </body>
 </html>
+




More information about the Monodevelop-patches-list mailing list