Jump to: navigation, search

Difference between revisions of "PTP/photran/documentation"

< PTP‎ | photran
m
(Replacing page with '== Documentation == {| |- | Photran 5.0 User's Guide | User's Guide for Photran 5.0 (Eclipse 3.5/CDT 6.0) |} Category:Photran')
Line 1: Line 1:
<big><big><big><big>Photran 5.0 User's Guide</big></big></big></big>
+
== Documentation ==
<br>
+
{|
<br>
+
|-
'''IMPORTANT:''' For the time being, this is just an outline of the
+
| [[PTP/photran/documentation/photran5 | Photran 5.0 User's Guide]]
documentation we intend to write before the release of Photran 5.0
+
| User's Guide for Photran 5.0 (Eclipse 3.5/CDT 6.0)
in September, 2009. It is not useful yet. Of course, you are
+
|}
welcome to fill in any sections you wish... this is a wiki!
+
  
=Installing Photran=
+
[[Category:Photran]]
TODO
+
* System requirements
+
* Special instructions for Windows, Mac users
+
 
+
=Starting a New Project=
+
TODO
+
 
+
==Managed Make==
+
TODO
+
 
+
==Standard Make==
+
TODO
+
 
+
=Writing Code=
+
TODO
+
* The Fortran Perspective
+
* The Fortran Projects View
+
* Using the Fortran editor and Fortran perspective
+
** Selecting free vs. fixed form; watermark indicating content type mismatch
+
** Outline view - note Source Form marker in top, skull & crossbones
+
** Overview of the Fortran editors (incl. rulers, folding, smart highlighting)
+
** Comment/uncomment
+
** Setting bookmarks
+
** Go to line (Ctrl+L)
+
** Configuring the editor
+
*** Selecting horizontal ruler vs. folding
+
*** Setting colors for syntax highlighting
+
*** Showing print margin
+
*** Spaces instead of tabs
+
*** Show whitespace
+
*** Set font
+
*** Show line numbers
+
 
+
=Compiling Fortran Programs=
+
TODO
+
* refer to CDT
+
* Setting make targets - refer to CDT
+
* Error parsers
+
* Binary parsers - need to change if no "Run as Local Fortran App" menu item
+
 
+
=Running and Debugging Fortran Programs=
+
TODO
+
* refer to CDT
+
* Setting breakpoints
+
* Note compiler-specific problems
+
 
+
=Advanced Features=
+
TODO
+
 
+
==Introduction==
+
TODO
+
* Enabling
+
** Checkboxes in project properties
+
** Include paths
+
** Module paths
+
* Fortran Analysis/Refactoring Problems view
+
 
+
==Advanced Editing Features==
+
TODO
+
* Fortran Declaration view
+
* Content assist
+
 
+
==Search and Navigation==
+
TODO
+
* Open declaration
+
* Find references
+
* Fortran search dialog
+
 
+
==Refactoring==
+
TODO
+
** Introduction - note fixed form not supported
+
** How to activate
+
*** Refactor menu (if in editor)
+
*** Editor context menu (if in editor)
+
*** Fortran Projects View context menu (multiple files)
+
** Instructions for individual refactorings
+
 
+
===Rename===
+
TODO
+
 
+
===Introduce Implicit None===
+
TODO
+
 
+
===Move Saved Variables to Common Block===
+
TODO
+
 
+
===Replace Obsolete Operators===
+
TODO
+
 
+
===Extract Procedure===
+
TODO
+
 
+
=Troubleshooting=
+
TODO
+
* FAQ
+
* Mailing list
+
 
+
==Beyond Photran==
+
TODO
+
* Using Photran with other Eclipse plug-ins
+
** Subversion support
+
** PTP/RDT
+
** RSE
+

Revision as of 01:40, 9 July 2009

Documentation

Photran 5.0 User's Guide User's Guide for Photran 5.0 (Eclipse 3.5/CDT 6.0)