emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Building source code cross-reference?
@ 2016-02-04 15:23 Peter Davis
  0 siblings, 0 replies; only message in thread
From: Peter Davis @ 2016-02-04 15:23 UTC (permalink / raw)
  To: emacs-orgmode


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

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2016-02-04 15:23 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-02-04 15:23 Building source code cross-reference? Peter Davis

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).