docutils-checkins Mailing List for Docutils: Documentation Utilities (Page 382)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/docutils/sandbox/gschwant/docfactory
In directory sc8-pr-cvs1:/tmp/cvs-serv11268/sandbox/gschwant/docfactory

Modified Files:
	README.txt docfactory.py setup.py 
Log Message:
New release of DocFactory. 
Check HISTORY.txt for new features.
Be sure to upgrade to wxPython 2.3.4.2.     



Index: README.txt
===================================================================
RCS file: /cvsroot/docutils/sandbox/gschwant/docfactory/README.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6

--- README.txt	3 Oct 2002 10:51:09 -0000	1.5
+++ README.txt	8 Jan 2003 22:23:36 -0000	1.6
@@ -1,21 +1,19 @@
 =====================
- README: DocFactory_
+ DocFactory_ README
 =====================
 
 :author:    Dr. Gunnar Schwant
 :contact:   g.s...@gm...
-:date:      $Date$
-:version:   0.1.4
+:date:      2003/01/07
+:version:   0.2
 :copyright: Copyright (c) 2002 Dr. Gunnar Schwant (g.s...@gm...).
             All rights reserved.  See LICENSE.txt_ for license details.
 
 :abstract: This is a short introduction to DocFactory.  Hopefully,
            more documentation will be available soon.
 
-.. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/
-
-.. sectnum::
 .. contents::
+.. section-numbering::
 
 
 What is it?
@@ -41,7 +39,7 @@
 
 * Python 2.1.1 or later (http://www.python.org).
 
-* wxPython 2.3.2.1 or later (http://wxpython.org).  Be sure to get the
+* wxPython 2.3.4.2 or later (http://wxpython.org).  Be sure to get the
   build matching the version of Python you're using.
 
 * Docutils 0.2.2 or later (http://docutils.sourceforge.net).  Use the
@@ -107,7 +105,7 @@
 
 Type ``Ctrl+N`` to create a new text file.  You will be asked for a
 location and title of the new file.  Afterwards the file will be
-created, added to the tree on the left and loaded it into the editor.  
+created, added to the tree on the left and loaded it into the editor.
 As you will notice the title has been inserted at the top of the
 file.
 
@@ -116,7 +114,17 @@
 
 To open an already existing text file simply type ``Ctrl+O`` and
 select the file. It will be added to the tree and loaded into
-the editor.
+the editor.  Moreover, you can open a file from the command-line 
+if you specify the file as first parameter.  A command like ``python 
+[Scripts-directory]/docfactory.py [<file>]`` should launch DocFactory 
+and open the file for editing.  (Of course, this command depends on your 
+system.  For example::
+
+    C:\>python Python22\Scripts\docfactory.py temp\test.txt
+
+works on my windows machine.  In particular, the Python executable has
+to be on your path.)
+
 
 Publish a file as HTML
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -126,11 +134,14 @@
 The HTML file is created in the directory of your text file and you can 
 customize processing by setting up Docutils configuration files. [2]_
 
-As soon as the processing is finished the HTML-file will be displayed 
-in a preview page.  Please note that this preview does **not** support 
-stylesheets.  If you want to have a look at the document in your default
-webbrowser (which hopefully does support stylesheets) click on "View 
-In Browser".
+As soon as the processing is finished the HTML-file will be displayed on 
+DocFactory's HTML-viewer page.  Please note that this viewer does support 
+stylesheets on Windows platforms only (including Windows 95, 98, ME, 2000, 
+NT, XP).  On any other platform you will have to check the final layout 
+with a webbrowser of your choice (which hopefully does support stylesheets).
+Click on "View In Browser" to open the file with your system's default 
+webbrowser.
+
 
 Projects
 --------
@@ -169,82 +180,139 @@
 Press the "OK"-button to finish the setup.  The project appears as part
 of the tree on the left. 
 
+**A note on stylesheets:** You shouldn't worry about the stylesheet.  When 
+you leave the "Project Settings" dialog DocFactory checks if the stylesheet
+is present.  If the stylesheet can not be found a dialog window will pop up 
+and ask you if you want that DocFactory creates a stylesheet for you.  You 
+will be offered two different styles ("Classic" and "Modern").  Select one 
+and press "OK".
+
+
 Adding files to a project
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In order to create a new file within a project or add an existing file 
 to a project simply activate the project's item in the tree on the left 
-(double-click) and press ``Ctrl+N`` or ``Ctrl+O`` as described above. 
-The behaviour is like this: If a project is active any file which is 
-created and/or opened will be added to the active project.  (If no 
-project is active files will be created/opened outside of projects.)
+(double-click) and press ``Ctrl+N`` or ``Ctrl+O``.  The behaviour is like 
+this: If a project is active any file which is created and/or opened will 
+be added to the active project.  (If no project is active files will be 
+created/opened outside of projects.)
+
+
+Editing
+-------
 
 Keyboard Shortcuts
-------------------
+~~~~~~~~~~~~~~~~~~
 
 For rapid development DocFactory features Windows-style keyboard
 shortcuts:
 
-==============================  ======================================
+==============================  =======================================
 Action                          Keyboard Shortcut
-==============================  ======================================
+==============================  =======================================
 **File Menu**
-----------------------------------------------------------------------
+-----------------------------------------------------------------------
 New File                        Ctrl+N
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 Open File                       Ctrl+O
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 Save File                       Ctrl+S
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 Exit Application                Alt+X
-------------------------------  --------------------------------------
-
+------------------------------  ---------------------------------------
+**Edit Menu**
+-----------------------------------------------------------------------
+Undo                            Ctrl+Z
+------------------------------  ---------------------------------------
+Redo                            Ctrl+Y
+------------------------------  ---------------------------------------
+Cut                             Shift+Del, Ctrl+X
+------------------------------  ---------------------------------------
+Copy                            Ctrl+Ins, Ctrl+C
+------------------------------  ---------------------------------------
+Paste                           Shift+Ins, Ctrl+V
+------------------------------  ---------------------------------------
+Select all                      Ctrl+A
+------------------------------  ---------------------------------------
+Find & Replace                  Ctrl+F
+------------------------------  ---------------------------------------
+Goto line                       Ctrl+G
+------------------------------  ---------------------------------------
 **Process Menu**
-----------------------------------------------------------------------
+-----------------------------------------------------------------------
 To HTML                         F7
-------------------------------  --------------------------------------
-
-**Editing**
-----------------------------------------------------------------------
+------------------------------  ---------------------------------------
+**Further editing commands**
+-----------------------------------------------------------------------
 Cursor movement                 Arrow keys or mouse
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 Beginning of line               Home
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 End of line                     End
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 Beginning of buffer             Ctrl+Home
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 End of the buffer               Ctrl+End
-------------------------------  --------------------------------------
-Select text                     Hold down Shift while moving the
-                                cursor
-------------------------------  --------------------------------------
-Select all text                 Ctrl+A
-------------------------------  --------------------------------------
-Copy                            Ctrl+Ins, Ctrl+C
-------------------------------  --------------------------------------
-Cut                             Shift+Del, Ctrl+X
-------------------------------  --------------------------------------
-Paste                           Shift+Ins, Ctrl+V
-------------------------------  --------------------------------------
-Undo                            Ctrl+Z
-------------------------------  --------------------------------------
-Redo                            Ctrl+Y
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
+Select text                     Hold down Shift while moving the cursor
+------------------------------  ---------------------------------------
 Zoom-In                         Ctrl+L
-------------------------------  --------------------------------------
+------------------------------  ---------------------------------------
 Zoom-Out                        Ctrl+K
-==============================  ======================================
+==============================  =======================================
 
 Right mouse-click brings up a popup-dialog with most of the above
 editor commands.  Moreover, you can use the mouse to move selected
 text.
 
 
-*Now, this should be enough for the beginning.  Start playing with
-DocFactory, have fun, report bugs, contribute, ...  Any kind of
-feedback is welcome.*
+Find & Replace
+~~~~~~~~~~~~~~
+
+The "Find & Replace"-dialog was introduced with DocFactory release 0.2
+and is special in the sense that it uses `regular expression syntax`_ 
+for searching as defined by Python's re-module.  This offers a great deal
+of flexibility in searching.  For example: Searching for ``Fred|Ted`` will
+search the file for appearances of ``Fred`` as well as for appearances
+of ``Ted``.  However, it also requires a certain kind of familiarity with
+Python's regular expression syntax.  For example: In order to find 
+appearances of ``C:\temp\test.txt`` you will have to search for 
+``C:\\temp\\test.txt``.
+
+
+Data storage
+============
 
+DocFactory uses the Python's ConfigParser_-module to store any information 
+about projects which has to be saved between runs.  The storage file has
+a ``[docfactory_project: <name of project>]`` section for each project.
+(``<name of project>`` is replaced by the project's name.) Each section
+header is followed by two ``name=value`` entries: One for all project
+files and one for the outputdirectory. For example: The section for
+a project called ``project_01`` which consists of two files ``C:\file1.txt``,
+``C:\file2.txt`` and whose outputdirectory is ``C:\project1`` looks
+like this::
+
+    [docfactory_project: project_01]
+    files=C:\file1.txt;C:\file2.txt
+    outputdirectory=C:\project1
+
+As default the data storage file is located in the module's directory 
+(``os.path.dirname(docutils.factory.__file__)``). The default name of the 
+file is ``docfactory.dat``. 
+
+You can change the name and location of the data storage file by creating 
+a file called ``conf.pth`` in the module's directory.  This file should 
+consist of one line only which is the complete data storage path. For 
+example:  If the first line of ``conf.pth`` is 
+
+::
+
+    /home/fred/.docfactory
+
+DocFactory will store its data in ``/home/fred/.docfactory``.
+ 
 
 Future Directions
 =================
@@ -255,8 +323,13 @@
 
 * more stylesheets (please contribute!)
 * preferences dialog
-* find & replace dialog
-* ...
+* [...]
+
+*Now, this should be enough for the beginning.  Start playing with
+DocFactory, have fun, report bugs, contribute, ...  Any kind of
+feedback is welcome.*
+
+---------
 
 .. Footnotes
 
@@ -269,8 +342,11 @@
 
 .. Hyperlinks
 
-.. _LICENSE.txt:           LICENSE.html
-.. _reStructuredText:      http://docutils.sourceforge.net/rst.html
-.. _Python:                http://www.python.org
-.. _wxPython:              http://wxpython.org
-.. _Docutils:              http://docutils.sourceforge.net
+.. _LICENSE.txt:                 LICENSE.html
+.. _reStructuredText:            http://docutils.sourceforge.net/rst.html
+.. _Python:                      http://www.python.org
+.. _wxPython:                    http://wxpython.org
+.. _Docutils:                    http://docutils.sourceforge.net
+.. _`regular expression syntax`: http://www.python.org/doc/current/lib/re-syntax.html
+.. _ConfigParser:                http://www.python.org/doc/current/lib/module-ConfigParser.html
+.. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/

Index: docfactory.py
===================================================================
RCS file: /cvsroot/docutils/sandbox/gschwant/docfactory/docfactory.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- docfactory.py	30 Sep 2002 20:07:54 -0000	1.2
+++ docfactory.py	8 Jan 2003 22:23:36 -0000	1.3
@@ -3,7 +3,7 @@
 """
 :author:  Dr. Gunnar Schwant
 :contact: g.s...@gm...
-:version: 0.1.4
+:version: 0.2
 """
 
 from docutils.factory import main

Index: setup.py
===================================================================
RCS file: /cvsroot/docutils/sandbox/gschwant/docfactory/setup.py,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- setup.py	30 Sep 2002 18:58:15 -0000	1.3
+++ setup.py	8 Jan 2003 22:23:38 -0000	1.4
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# $Id$
 
 from distutils.core import setup
 
@@ -13,7 +12,7 @@
 System requirements:
 
 * Python 2.1.1 or later (http://www.python.org).
-* wxPython 2.3.2.1 or later (http://wxpython.org).  Be sure to get the
+* wxPython 2.3.4.2 or later (http://wxpython.org).  Be sure to get the
   build matching the version of Python you're using.
 * Docutils 0.2.2 or later (http://docutils.sourceforge.net).  Use the
   CVS snapshot.
@@ -26,7 +25,7 @@
           long_description = LONG_DESCRIPTION,
           url = ('http://docutils.sourceforge.net/sandbox/gschwant/'
                  'docfactory/'),
-          version = '0.1.4',
+          version = '0.2',
           author = 'Dr. Gunnar Schwant',
           author_email = 'g.s...@gm...',
           license = 'BSD (see LICENSE.txt)',






2002	Jan	Feb	Mar	Apr (106)	May (215)	Jun (104)	Jul (290)	Aug (351)	Sep (245)	Oct (289)	Nov (184)	Dec (113)
2003	Jan (179)	Feb (88)	Mar (77)	Apr (70)	May (107)	Jun (288)	Jul (115)	Aug (67)	Sep (91)	Oct (34)	Nov (31)	Dec (61)
2004	Jan (54)	Feb (17)	Mar (102)	Apr (152)	May (178)	Jun (377)	Jul (136)	Aug (37)	Sep (196)	Oct (142)	Nov (119)	Dec (58)
2005	Jan (51)	Feb (76)	Mar (220)	Apr (132)	May (134)	Jun (230)	Jul (142)	Aug (58)	Sep (71)	Oct (76)	Nov (129)	Dec (117)
2006	Jan (94)	Feb (30)	Mar (97)	Apr (63)	May (63)	Jun (62)	Jul (23)	Aug (40)	Sep (47)	Oct (40)	Nov (23)	Dec (21)
2007	Jan (57)	Feb (65)	Mar (77)	Apr (23)	May (118)	Jun (127)	Jul (87)	Aug (33)	Sep (26)	Oct (8)	Nov (4)	Dec (25)
2008	Jan (16)	Feb (18)	Mar (16)	Apr (4)	May (22)	Jun (20)	Jul (38)	Aug (14)	Sep (18)	Oct (68)	Nov (16)	Dec (95)
2009	Jan (28)	Feb (16)	Mar (8)	Apr (44)	May (35)	Jun (41)	Jul (63)	Aug (40)	Sep (38)	Oct (41)	Nov (17)	Dec (9)
2010	Jan (9)	Feb (3)	Mar (71)	Apr (20)	May (15)	Jun (16)	Jul (33)	Aug (13)	Sep (39)	Oct (30)	Nov (25)	Dec (20)
2011	Jan (213)	Feb (252)	Mar (24)	Apr (24)	May (20)	Jun (21)	Jul (37)	Aug (18)	Sep (28)	Oct (65)	Nov (22)	Dec (48)
2012	Jan (35)	Feb (39)	Mar (17)	Apr (9)	May (37)	Jun (31)	Jul (23)	Aug (14)	Sep (16)	Oct (15)	Nov (5)	Dec (43)
2013	Jan (15)	Feb (19)	Mar (26)	Apr (13)	May (9)	Jun (11)	Jul (32)	Aug (9)	Sep (6)	Oct	Nov (13)	Dec (5)
2014	Jan (2)	Feb (3)	Mar (1)	Apr	May (2)	Jun (4)	Jul (18)	Aug	Sep	Oct (3)	Nov (4)	Dec (2)
2015	Jan (3)	Feb (25)	Mar (49)	Apr (28)	May (13)	Jun (2)	Jul (2)	Aug (14)	Sep (9)	Oct (6)	Nov	Dec (2)
2016	Jan (2)	Feb (1)	Mar	Apr	May (12)	Jun	Jul (17)	Aug (7)	Sep (3)	Oct (2)	Nov (5)	Dec (28)
2017	Jan (11)	Feb (6)	Mar (10)	Apr (10)	May (34)	Jun (32)	Jul (15)	Aug (28)	Sep (8)	Oct (10)	Nov (14)	Dec (2)
2018	Jan (8)	Feb	Mar	Apr	May	Jun (5)	Jul (7)	Aug	Sep (1)	Oct	Nov (15)	Dec
2019	Jan	Feb (7)	Mar (2)	Apr (2)	May (2)	Jun (2)	Jul (48)	Aug (73)	Sep (22)	Oct (8)	Nov (16)	Dec (26)
2020	Jan (30)	Feb (13)	Mar (15)	Apr (6)	May (1)	Jun (3)	Jul (12)	Aug (18)	Sep (18)	Oct (5)	Nov (9)	Dec (16)
2021	Jan (13)	Feb (17)	Mar (19)	Apr (70)	May (43)	Jun (27)	Jul (18)	Aug (15)	Sep (16)	Oct (37)	Nov (38)	Dec (11)
2022	Jan (73)	Feb (18)	Mar (36)	Apr (6)	May (8)	Jun (33)	Jul (22)	Aug	Sep (6)	Oct (71)	Nov (91)	Dec (26)
2023	Jan (12)	Feb (5)	Mar (5)	Apr (34)	May (29)	Jun (27)	Jul (3)	Aug (17)	Sep (11)	Oct (4)	Nov (34)	Dec (7)
2024	Jan (16)	Feb (27)	Mar (60)	Apr (38)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

docutils-checkins Mailing List for Docutils: Documentation Utilities (Page 382)

docutils-checkins — SVN checkin messages, auto-generated.