[Mono-docs-list] Monodoc as an editor
Miguel de Icaza
miguel@ximian.com
25 Jul 2003 02:17:31 -0400
--=-8GymKOyD4bHV+uVyrnnT
Content-Type: text/plain
Content-Transfer-Encoding: 7bit
Hey guys,
I just wanted to record the idea here, because I remember it was
mentioned some time ago, and we discussed this today. We have been
thinking about making Monodoc an editor for documentation; Unlike the
previous approach, we are thinking about a very conservative effort.
The idea is that when a special editing mode is turned on, different
elements in the ECMA documentation (those that we are supposed to edit)
would show up next to them as a link, like this:
Sample
Summary:
This class does
interesting things [Edit
this]
Remarks:
Avoid using this
class from a thread, or
operating it while
drunk, it might have
adverse effects on
the system's health.
[Edit this]
There is some code on CVS that turns the link on for summaries of
classes I believe (export the MONODOC_EDITING environment variable to
see it).
To make this happen we would need:
* To add [Edit this] links to the mono-ecma.xsl file in the proper
places.
* To "expand" the anchor target to include the element to be
edited; For example
Those of us involved in Monodoc are very busy, and we do not have a
lot of spare time to take this project to the end, but there are various
concrete tasks that could be done to advance this project.
--
Miguel de Icaza <miguel@ximian.com>
--=-8GymKOyD4bHV+uVyrnnT
Content-Type: text/html; charset=utf-8
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">
<META NAME="GENERATOR" CONTENT="GtkHTML/3.0.7">
</HEAD>
<BODY>
Hey guys,<BR>
<BR>
I just wanted to record the idea here, because I remember it was mentioned some time ago, and we discussed this today. We have been thinking about making Monodoc an editor for documentation; Unlike the previous approach, we are thinking about a very conservative effort.<BR>
<BR>
The idea is that when a special editing mode is turned on, different elements in the ECMA documentation (those that we are supposed to edit) would show up next to them as a link, like this:<BR>
<BR>
<TABLE BGCOLOR="#7f7f7f" CELLSPACING="0" CELLPADDING="3">
<TR>
<TD>
<FONT COLOR="#ffffff"><B>Sample</B></FONT>
</TD>
</TR>
</TABLE>
<BR>
<TABLE BGCOLOR="#bfbfbf" CELLSPACING="0" CELLPADDING="0" WIDTH="100%">
<TR>
<TD>
<TABLE BGCOLOR="#f2f2f2" CELLSPACING="1" CELLPADDING="3" WIDTH="100%">
<TR>
<TD>
<BR>
</TD>
<TD>
<B>Summary:</B>
</TD>
<TD>
<BR>
</TD>
</TR>
<TR>
<TD>
</TD>
<TD>
This class does interesting things <A HREF="edit-summary">[Edit this]</A><BR>
<BR>
<B>Remarks:<BR>
</B>Avoid using this class from a thread, or operating it while drunk, it might have<BR>
adverse effects on the system's health. <A HREF="edit-me:">[Edit this]</A>
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
<BR>
</TD>
<TD>
<BR>
</TD>
<TD>
<BR>
</TD>
</TR>
</TABLE>
</TD>
</TR>
</TABLE>
<BR>
<BR>
There is some code on CVS that turns the link on for summaries of classes I believe (export the MONODOC_EDITING environment variable to see it).<BR>
<BR>
To make this happen we would need:<BR>
<BR>
<UL>
<LI>To add [Edit this] links to the mono-ecma.xsl file in the proper places.
<LI>To "expand" the anchor target to include the element to be edited; For example
</UL>
<BR>
Those of us involved in Monodoc are very busy, and we do not have a lot of spare time to take this project to the end, but there are various concrete tasks that could be done to advance this project.<BR>
<BR>
<BR>
<TABLE CELLSPACING="0" CELLPADDING="0" WIDTH="100%">
<TR>
<TD>
-- <BR>
Miguel de Icaza <<A HREF="mailto:miguel@ximian.com"><U>miguel@ximian.com</U></A>>
</TD>
</TR>
</TABLE>
</BODY>
</HTML>
--=-8GymKOyD4bHV+uVyrnnT--