emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Peter Davis <pfd@pfdstudio.com>
To: emacs-orgmode@gnu.org
Subject: Building source code cross-reference?
Date: Thu, 04 Feb 2016 10:23:23 -0500	[thread overview]
Message-ID: <6sw6c7egcsmrdg.fsf@dhcp-7-52.hmco.com> (raw)


I'm doing some Ruby on Rails development now, and I find it very difficult to keep track of which files are involved in which
features in a complex project. For any given Web page, each feature might have its own /view/, which in turn has its own /controller/,
and may involve one or more /models/, and so forth. There may be helpers, stylesheets, etc. which all apply.

So now I'm thinking I can build a cross-reference, so when I have to revisit something I worked on months ago, I can jump straight
to the relevant line in each of these files. I know org-mode files can contain file references, including line numbers, so I can do
something like:

#+BEGIN_EXAMPLE
 * Product Listing
   * [[~/blahblahblah/app/controllers/product_controller.rb::123][listing method]]
   * [[~/blahblahblah/app/views/product/listings.html.erb::456][listing view]]
#+END_EXAMPLE

and so on. This would be extremely helpful.

I know I can build this by hand, but I wondered if anyone had found a way to automate or partially automate building a cross
reference like this. It seems like org-capture comes close, with a little coaxing and customization. If there are similar tools for
other languages, I'd love to hear about those. (I know about doxygen, but there's no ruby-on-rails version of that, as far as I can
tell.) 

Thoughts?

Thanks!
-pd

                 reply	other threads:[~2016-02-04 15:23 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6sw6c7egcsmrdg.fsf@dhcp-7-52.hmco.com \
    --to=pfd@pfdstudio.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).