Anonymous avatar Anonymous committed 0240d27

Moved feature list to rope.txt

Comments (0)

Files changed (4)

 Getting Started
 ===============
 
-* List of features: `docs/index.txt`_
+* List of features: `docs/rope.txt`_
 * Using as a library: `docs/library.txt`_
 * Contributing: `docs/contributing.txt`_
 
 Have a look at ``COPYING`` file for more information.
 
 
-.. _`docs/index.txt`: docs/index.html
+.. _`docs/rope.txt`: docs/rope.html
 .. _`docs/contributing.txt`: docs/contributing.html
 .. _`docs/library.txt`: docs/library.html

docs/index.txt

-======
- rope
-======
-
-``a python refactoring library ...``
-
-
-Overview
-========
-
-*Rope* is a python refactoring library.  It supports many refactorings
-and features (see status_ section).
-
-*Ropeide* is an IDE that uses *rope* library to provide features like
-refactoring, code assist and auto-completion.  It uses `Tkinter`
-library.
-
-*Ropemacs* is an Emacs mode for using rope library in emacs.  It uses
-Pymacs_.
-
-Note that rope ``0.5`` was the last version that supported Python
-``2.4`` and currently rope requires Python ``2.5``.
-
-
-Status
-======
-
-Features implemented so far:
-
-* Refactorings
-
-  * Rename everything!
-  * Extract method/local variable
-  * Move class/function/module/package/method
-  * Inline method/local variable
-  * Change method signature
-  * Restructuring (like converting ``${?a}.f(${?b})`` to
-    ``${?b}.g(${?a})`` where ``a.type == mymod.A``)
-  * Introduce factory method
-  * Introduce parameter
-  * Encapsulate field
-  * Transform module to package
-  * Convert local variable to field
-  * Replace method with method object
-  * Inline argument default value
-
-* Refactoring Features
-
-  * Extracting similar statements in extract refactorings
-  * Basic implicit interfaces handling in rename and change signature
-  * Fixing imports when needed
-  * Previewing refactorings
-  * Stopping refactorings
-  * Undo/redo refactorings
-  * Mercurial_ support in refactorings
-  * SVN support in refactorings using pysvn_ library
-
-* Code-assists
-
-  * Auto-completion
-  * Goto definition
-  * Quick outline
-  * Show PyDoc
-  * Proposing templates in completions
-  * Find occurrences
-  * Import tools
-
-    * Organize imports (remove unused and duplicate imports and sort them)
-    * Change relative imports to absolute
-    * Change from imports to normal imports
-    * Expand ``from ... import *`` imports
-
-  * Generating python elements
-  * Sorting scopes
-
-* Object Inference
-
-  * A static object inference approach
-  * A dynamic object inference approach
-  * Automatic SOI analysis
-  * Handling built-in container types
-  * Saving object information on disk
-  * Stored object information validation
-
-* *Ropemacs* emacs plugin that uses Pymacs_
-
-* *Ropeide* features
-
-  * Python and reST highlighting
-  * Multiple editers
-  * Project file history
-  * An emacs like keybinding
-  * Configurable keybinding
-  * Basic UI plug-in support
-  * Spell-checking using Aspell/Ispell
-  * Correcting indentation
-  * Project tree view
-  * Unit-test running view
-  * Basic codetags/errors/warnings listing
-  * Defining templates
-  * Memorizing strings/locations
-
-
-For more information see `overview.txt`_.  Here are a few
-`screenshots`_.  You might like to have a look at:
-
-* Using as a library: `library.txt`_
-* Contributing: `contributing.txt`_
-
-
-Download
-========
-
-You can download rope from `project download page`_.
-
-
-Source Repository
-=================
-
-Rope uses Mercurial_ CMS:
-
-* Rope main branch: http://rope.sourceforge.net/hg/rope
-* Rope py3k branch: http://rope.sourceforge.net/hg/rope_py3k
-
-
-Feedback
-========
-
-Send your bug reports, feature requests and patches to `rope-dev (at)
-googlegroups.com`_.
-
-
-License
-=======
-
-rope is under the terms of GNU GPL (GNU General Public License).
-
-.. _project download page: http://sf.net/projects/rope/files
-.. _`rope-dev (at) googlegroups.com`: http://groups.google.com/group/rope-dev
-.. _pysvn: http://pysvn.tigris.org
-.. _Mercurial: http://selenic.com/mercurial
-.. _`contributing.txt`: contributing.html
-.. _`library.txt`: library.html
-.. _overview.txt: overview.html
-.. _screenshots: screenshots/screenshots.html
-.. _pymacs: http://www.iro.umontreal.ca/~pinard/pymacs/

docs/overview.txt

 
 
 The purpose of this file is to give an overview of some of rope's
-features.  It is incomplete.  Because rope is enhancing very fast
-some of the features shown here are old and do not show what rope
-can do in extremes.  So if you really want to feel the power of
-rope try its features and see its unit tests.
+features.  It is incomplete.  And some of the features shown here are
+old and do not show what rope can do in extremes.  So if you really
+want to feel the power of rope try its features and see its unit
+tests.
 
-Note that the IDE parts of this file assumes emacs keybinding.
+Note that the keys mentioned in this file are the ones that are used
+in ropeide.
 
 
 .. contents:: Table of Contents
 
 .. _pysvn: http://pysvn.tigris.org
 .. _Mercurial: http://selenic.com/mercurial
-
-
-Project History
-===============
-
-The "Undo/Redo Project Change" in the edit menu undoes every change
-made to the files in a project; like saving files, creating files and
-folders and refactorings.  Also in "Project History" dialog you can
-see and select changes to be undone in any order.  Note that undoing
-changes in project history undoes the changes it depends on, too.
-
-
-IDE Tools
-=========
-
-Keybinding
-----------
-
-You can change the keybinding in ``~/.ropeide``.  The keybinding is
-shown next to every action in menus.  Some of these bindings are
-chosen from emacs and some from eclipse.  ("C" stands for Control key
-and "M" for Meta(Alt) key.)
-
-
-Code Assist(Auto Complete)
---------------------------
-
-You can complete names as you type by using code assist (``M-/``).
-The two capital letters in the left shows the type of the proposal.
-In the first column:
-
-* L: ``local``
-* G: ``global``
-* A: ``attribute``
-* T: ``template``
-* K: ``keyword``
-* B: ``built-in``
-* P: ``parameter_keyword``
-
-In the second column if present:
-
-* C: ``class``
-* F: ``function``
-* V: ``variable``
-* P: ``paramter``
-* I: ``imported``
-
-You can use ``main``, ``testcase``, ``hash``, ``eq`` and ``super``
-templates.  You can define your own templates in ``~/.ropeide``.  See
-examples in the default ``~/.ropeide`` file. (`rope.ui.dot_rope`
-module; It will be copied to ``~/.ropeide`` if none already exists.)
-
-
-Show PyDoc
-----------
-
-By using ``C-c C-d`` you can tell rope to show the pydoc of a name if
-available.
-
-
-Goto Definition
----------------
-
-You can use ``C-c g`` for going to the line a name was defined in.
-
-
-Generate Python Elements
-------------------------
-
-The generate element actions make python elements.  You have to move
-on an element that does not exist and perform one of these generate
-actions.  For example::
-
-  my_print(var=1)
-
-Calling generate function on `my_print` (``C-c n f``) will result in::
-
-  def my_print(var):
-      pass
-
-
-  my_print(var=1)
-
-It handle methods, static methods, classes, variables, modules, and
-packages, too.  Generate element actions use ``C-c n`` prefix.
-
-
-Sorting Scope Elements
-----------------------
-
-You can use ``C-c s ...`` for sorting current scope.  ``...`` can be
-one of:
-
-* ``a``: alphabetically
-* ``k``: classes first
-* ``u``: underlineds first
-* ``p``: those that have pydoc first
-* ``s``: special methods first
-
-You can sort in the reverse order by using ``C-u`` prefix..  Sorts are
-stable.  So if you want to sort by kind and alphabetically, for
-instance, you can use ``C-c s a`` followed by ``C-c s k``.
-
-
-Saving Locations And Strings
-----------------------------
-
-Rope can now save locations or strings in memory.  These are similar
-to emacs's bookmarks and registers.  These actions use ``C-x m``
-prefix.
-
-
-Defining Templates
-------------------
-
-You can define your own templates in ``~/.ropeide``.  You can use
-``C-x c`` and a line like this::
-
-    core.add('templates', ('say_hello', "print 'Hello, my name is ${name}'\n"))
-
-This defines a new python template called ``say_hello``.  Now if you
-type ``say_`` in a python file and use code-assist (``M-/``), this
-template will be proposed.  If you press enter you can insert the
-value to be used as ``name``.
-
-
-Spell-Checker
--------------
-
-The new spell-checker uses ispell/aspell if available.  You can use
-``M-$`` like emacs for checking current word.  You can also use ``C-x
-$ r`` and ``C-x $ b`` for spell-checking region and buffer.
-
-
-Outline
--------
-
-In tree views (like quick outline and project tree views) you can use
-``C-n`` and ``C-p`` to navigate and ``+`` and ``-`` to expand and
-collapse items.  You can use the ``Return`` key to select items.
+======
+ rope
+======
+
+``a python refactoring library ...``
+
+
+Features
+========
+
+Features implemented so far:
+
+* Refactorings
+
+  * Rename everything!
+  * Extract method/local variable
+  * Move class/function/module/package/method
+  * Inline method/local variable
+  * Change method signature
+  * Restructuring (like converting ``${?a}.f(${?b})`` to
+    ``${?b}.g(${?a})`` where ``a.type == mymod.A``)
+  * Introduce factory method
+  * Introduce parameter
+  * Encapsulate field
+  * Transform module to package
+  * Convert local variable to field
+  * Replace method with method object
+  * Inline argument default value
+
+* Refactoring Features
+
+  * Extracting similar statements in extract refactorings
+  * Basic implicit interfaces handling in rename and change signature
+  * Fixing imports when needed
+  * Previewing refactorings
+  * Stopping refactorings
+  * Undo/redo refactorings
+  * Mercurial_ support in refactorings
+  * SVN support in refactorings using pysvn_ library
+
+* Code-assists
+
+  * Auto-completion
+  * Goto definition
+  * Quick outline
+  * Show PyDoc
+  * Proposing templates in completions
+  * Find occurrences
+  * Import tools
+
+    * Organize imports (remove unused and duplicate imports and sort them)
+    * Change relative imports to absolute
+    * Change from imports to normal imports
+    * Expand ``from ... import *`` imports
+
+  * Generating python elements
+  * Sorting scopes
+
+* Object Inference
+
+  * A static object inference approach
+  * A dynamic object inference approach
+  * Automatic SOI analysis
+  * Handling built-in container types
+  * Saving object information on disk
+  * Stored object information validation
+
+
+.. _pysvn: http://pysvn.tigris.org
+.. _Mercurial: http://selenic.com/mercurial
+.. _pymacs: http://www.iro.umontreal.ca/~pinard/pymacs/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.