CEDET

David,

I will look over the manual over the next few days.

One thing I wanted to point out right away is that you don't
need NEXT, PREV, and UP links on the @node line.
If you use `texinfo-all-menus-update' rather than
`texinfo-every-node-update', then such links won't be created.
Here is what I use to delete them.

(defun texinfo-delete-node-links ()
  "Delete the NEXT, PREV, and UP links following @node name
as well the following line if it starts with @comment
for all nodes in the current buffer.
These are not necessary.  In fact they are nuisance if one wants to
split one file into several files or if one wants to share a texinfo
file fragment in multiple texinfo documents."
  (interactive)
  (goto-char (point-min))
  (while (re-search-forward "^@node [^,]+," nil t)
    (delete-region (1- (match-end 0)) (progn (end-of-line) (point)))
    (forward-line 1)
    (if (looking-at "@comment")
	(kill-line 1))))

The next/prev/up links may have been needed many years ago
perhaps to help out makeinfo.  However makeinfo as well as
texi2html have been able to deal with lact of next/prev/up
links for several years now.

I have one question regarding semantic and wisent manuals.
Are you planning on keeping the two manuals separate?
Is there any plans to merge the two manuals together?

>>>>> "DP" == David Ponce <david@...> writes:
    DP> 
    DP> Hi Eric & Richard,
    DP> These last days I mainly worked on completing the Wisent's manual in
    DP> file wisent.texi.
    DP> 
    DP> It is not yet finished and I plan to add more new chapters and
    DP> examples ;-) But, IMO, the latest version I checked in begins to be
    DP> quite usable!
    DP> 
    DP> If you get enough time, I would like you have a look at it and tell me
    DP> your opinion.  Please don't hesitate to correct my English (nice way
    DP> for me to learn more ;-).  I am not sure at all that my phrases are
    DP> always well written, and are clear enough!
    DP> 
    DP> Thank you in advance for your help!
    DP> 
    DP> Sincerely,
    DP> David

>>> "Richard Y. Kim" <ryk@...> seems to think that:
  [ ... ]
>I have one question regarding semantic and wisent manuals.
>Are you planning on keeping the two manuals separate?
>Is there any plans to merge the two manuals together?
  [ ... ]

I think that would make sense.  The existing ll parser and wisent
parsers will both be active since they are good at different things.

I would like the split the manual into different parts and have them
merged via makeinfo though.  Some parts are getting hard to find in
the very long manual code.  I suspect you may have the best ideas for
such an organizational change.

Eric

-- 
          Eric Ludlam:                 zappo@..., eric@...
   Home: http://www.ultranet.com/~zappo            Siege: http://www.siege-engine.com
Emacs: http://cedet.sourceforge.net               GNU: http://www.gnu.org

Eric,

I'll be glad to propose an outline of a semantic/wisent
combined manual if that is ok with you and David.

I would like to share with you a small elisp utility that I
wrote which I find very useful.  While browsing semantic or
wisent manual within the *info* buffer, I type "S" key and
the texinfo manual buffer pops up with the cursor at the
node corresponding to current info node!

The utility consists of one variable and one function:

(defvar ryk-info-to-texinfo-mapping nil
  "A list of (NAME . VALUE), i.e., an alist.
NAME is the info file name without directory path.
VALUE is the TAGS file name to use to look up info node names in
info file NAME.  See \\[ryk-find-texinfo-src-from-info-node].")

(defun ryk-find-texinfo-src-from-info-node ()
  "Jump to the texinfo source of the current info node.
Current info file is used as the key to \\[ryk-info-to-texinfo-mapping]
alist to find the TAG file.  Then \\[find-tag] is called on current info node."
  (interactive)
  (let* ((tags-table-list)
         (info-basename (file-name-sans-extension
			 (file-name-nondirectory Info-current-file)))
         (tags-file-name (cdr (assoc info-basename ryk-info-to-texinfo-mapping)))
         (tag-name (if Info-current-node
                       (format "@node %s" Info-current-node)
                     (read-string "Find tag in private notes: "
                                  (thing-at-point 'symbol)))))
    (find-tag tag-name)))

My personal customization of above utility is shown below.

(setq ryk-info-to-texinfo-mapping
      '(
        ("semantic"         . "/usr/local/src/cedet/semantic/TAGS.texi")
        ("wisent"           . "/usr/local/src/cedet/semantic/wisent/TAGS.texi")
        ))

(defun my-info-mode-hook ()
  (define-key Info-mode-map "S" 'ryk-find-texinfo-src-from-info-node)
  )

(add-hook 'Info-mode-hook 'my-info-mode-hook)

You would of course then need to do something like

    cd /usr/local/src/cedet/semantic; etags -o TAGS.texi *.texi 
    cd /usr/local/src/cedet/semantic/wisent; etags -o TAGS.texi *.texi 

Hope this helps.


>>>>> "EL" == Eric M Ludlam <eric@...> writes:
    EL> 
    >>>> "Richard Y. Kim" <ryk@...> seems to think that:
    EL>   [ ... ]
    >> I have one question regarding semantic and wisent manuals.
    >> Are you planning on keeping the two manuals separate?
    >> Is there any plans to merge the two manuals together?
    EL>   [ ... ]
    EL> 
    EL> I think that would make sense.  The existing ll parser and wisent
    EL> parsers will both be active since they are good at different things.
    EL> 
    EL> I would like the split the manual into different parts and have them
    EL> merged via makeinfo though.  Some parts are getting hard to find in
    EL> the very long manual code.  I suspect you may have the best ideas for
    EL> such an organizational change.

Richard,

 > I will look over the manual over the next few days.

Thanks!

 > One thing I wanted to point out right away is that you don't need
 > NEXT, PREV, and UP links on the @node line.  If you use
 > `texinfo-all-menus-update' rather than `texinfo-every-node-update',
 > then such links won't be created.  Here is what I use to delete
 > them.
[...]

Great tip!  I checked a new version in with NEXT, PREV, and UP links
removed ;-)

While we are speaking about texinfo...

Maybe could you help?  I tried to use the command
`texinfo-multiple-files-update' to update the main menu in wisent.texi
which includes the GNU Free Documentation License node but this just
replaces the current main menu in wisent.texi with only the item of
the external node :-( All other items for internal nodes are lost!  Is
there a way to automatically generate menus from both internal and
external nodes?  I didn't find how to do.

-----------------------------

[...]
 > I'll be glad to propose an outline of a semantic/wisent combined
 > manual if that is ok with you and David.

That's fine with me.

 > I would like to share with you a small elisp utility that I wrote
 > which I find very useful.  While browsing semantic or wisent manual
 > within the *info* buffer, I type "S" key and the texinfo manual
 > buffer pops up with the cursor at the node corresponding to current
 > info node!

Good idea!  Just a thought: `texinfo-mode' can be semantic-enabled,
maybe it would be possible to use Semantic tokens instead of etags?
And include your utility in semantic-texi.el?

Thanks again!
Sincerely,
David

>>>>> "DP" == David Ponce <david@...> writes:
    DP> [...]
    DP> Maybe could you help?  I tried to use the command
    DP> `texinfo-multiple-files-update' to update the main menu in wisent.texi
    DP> which includes the GNU Free Documentation License node but this just
    DP> replaces the current main menu in wisent.texi with only the item of
    DP> the external node :-( All other items for internal nodes are lost!  Is
    DP> there a way to automatically generate menus from both internal and
    DP> external nodes?  I didn't find how to do.

David,

I looked into using texinfo-multiple-files-update and
related commands a while ago, but as I recall there were
strict restrictions on the master texinfo file.
I believe one such restriction was that the content of each
chapter had to be in a separate file or something like that.

So I don't use texinfo-multiple-files-update.
Instead I use something I cooked up myself which has worked
out fine for me.  Here is how I split up texinfo files.

The master file looks like this:

    @node A
    @chapter A

    @include A.texi

    @node B
    @chapter B

    @include B.texi

A.texi looks like this:

    @ignore
    @node A
    @chapter A
    @end ignore

    @node A1
    @section A1

    ...

The use of @ignore is a trick to fool
texinfo-all-menus-update so that it will update the
top-level menu in A.texi.

With above setup, I can execute texinfo-all-menus-update on
all *.texi files independently and all is good.
The fact that I have to execute texinfo-all-menus-update on
each file has not bothered me at all, because If I forget,
makeinfo usually lets me know right away.

Hi Richard,

[...]
 > So I don't use texinfo-multiple-files-update.  Instead I use
 > something I cooked up myself which has worked out fine for me.  Here
 > is how I split up texinfo files.
[...]

Thanks again for this new great tip!  I checked new versions in of
wisent.texi and fdl.texi that use it ;-)

The manual also includes a new chapter on usage of start symbols in
grammars for Semantic (with the new API, not yet checked-in, to plug
parsers in :-)

Enjoy!
David