From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me X-Spam-Level: X-Spam-Status: No, score=-0.3 required=5.0 tests=BAYES_00, REPLYTO_WITHOUT_TO_CC autolearn=no autolearn_force=no version=3.4.4 X-Google-Thread: 103376,81054609038e88e3 X-Google-Attributes: gid103376,public X-Google-Language: ENGLISH,ASCII-7-bit Path: g2news1.google.com!news1.google.com!news.glorb.com!border1.nntp.dca.giganews.com!nntp.giganews.com!local1.nntp.dca.giganews.com!nntp.gbronline.com!news.gbronline.com.POSTED!not-for-mail NNTP-Posting-Date: Sun, 10 Oct 2004 09:07:47 -0500 Date: Sun, 10 Oct 2004 09:08:17 -0500 From: Wes Groleau Reply-To: groleau+news@freeshell.org Organization: Ain't no organization here! User-Agent: Mozilla Thunderbird 0.7.3 (Macintosh/20040803) X-Accept-Language: en-us, en MIME-Version: 1.0 Newsgroups: comp.lang.ada Subject: Re: Literate Programming in Ada, AdaDoc, AdaBrowse References: <2sqmccF1oit5sU1@uni-berlin.de> In-Reply-To: Content-Type: text/plain; charset=us-ascii; format=flowed Content-Transfer-Encoding: 7bit Message-ID: NNTP-Posting-Host: 69.9.86.94 X-Trace: sv3-sguSK/7PPPM0oMm2oJpiUSBtBSJRE5zmYzCOvOZLufsIdekrAC5jglTv0mKwFd0Rfaojdg86AsAUso1!Cq9PsGzhacFRgarTITPSXcc1zQgyTytuvRXB0N46E2+W3i69Tq1IhAD/q3kxnnxe0yJNV92Xq5Jo X-Complaints-To: abuse@gbronline.com X-DMCA-Complaints-To: abuse@gbronline.com X-Abuse-and-DMCA-Info: Please be sure to forward a copy of ALL headers X-Abuse-and-DMCA-Info: Otherwise we will be unable to process your complaint properly X-Postfilter: 1.3.19 Xref: g2news1.google.com comp.lang.ada:4991 Date: 2004-10-10T09:08:17-05:00 List-Id: Steve wrote: > Just to share another hairbrained scheme regarding documentation. > > What I would like to see is a fancy programming editor that allows you to > include text, graphics, spreadsheets, etc., in comments. > > A way to do this is to maintain the source code as text with special markers > referencing the comments, and maintain the comments in a separate file or > database. The approach has the advantage that the compiler doesn't have to > deal with the comments and the source may be viewed without the comments > using a different editor. It has the disadvantage that a special editor is > required to edit the code along with the comments, and since the code and > comments are in separate files, there is always potential of losing the > comment files. The editor could be made to output the source with comments > in a standard format: html, pdf, etc. Already available: fancy editor = WYSIWYG HTML or XML editor viewer = web browser special markers = XML tags This can be done in the style I earlier proposed, where the code is extracted from the file for compiling. But it can also be done where the HTML/XML appears ONLY in the code comments. In the latter, however, it may be difficult to make right margins (indents) look right. -- Wes Groleau A pessimist says the glass is half empty. An optimist says the glass is half full. An engineer says somebody made the glass twice as big as it needed to be.