[Moin-devel] CVS: dist/wiki/data/text HelpContents,1.11,1.12 HelpForDevelopers,1.6,1.7

Fri May 10 08:32:03 EDT 2002

Update of /cvsroot/moin/dist/wiki/data/text
In directory usw-pr-cvs1:/tmp/cvs-serv10762

Modified Files:
	HelpContents HelpForDevelopers 
Log Message:
Pointing to MoinDev

Index: HelpContents
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/HelpContents,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** HelpContents	4 Mar 2002 20:42:20 -0000	1.11
--- HelpContents	10 May 2002 15:31:34 -0000	1.12
***************
*** 17,21 ****
  An automatically generated index of all help pages is on HelpIndex. See also HelpMiscellaneous/FrequentlyAskedQuestions for answers to frequently asked questions.

! If you find any errors on the help pages, describe them on HelpErrata. 

  ''[Please do not add redundant information on these pages (which has to be maintained at two places then), and follow the established structure of help pages. Also note that the master set of help pages is not public, that this very page you read and all other help pages may be overwritten when the wiki software is updated. So if you have major contributions that should not get lost, send an extra notification notice to the MoinMoin user mailing list.]''
--- 17,21 ----
  An automatically generated index of all help pages is on HelpIndex. See also HelpMiscellaneous/FrequentlyAskedQuestions for answers to frequently asked questions.

! If you find any errors on the help pages, describe them on MoinMoin:HelpErrata. 

  ''[Please do not add redundant information on these pages (which has to be maintained at two places then), and follow the established structure of help pages. Also note that the master set of help pages is not public, that this very page you read and all other help pages may be overwritten when the wiki software is updated. So if you have major contributions that should not get lost, send an extra notification notice to the MoinMoin user mailing list.]''

Index: HelpForDevelopers
===================================================================
RCS file: /cvsroot/moin/dist/wiki/data/text/HelpForDevelopers,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** HelpForDevelopers	14 Mar 2002 21:30:41 -0000	1.6
--- HelpForDevelopers	10 May 2002 15:31:34 -0000	1.7
***************
*** 1,6 ****
- /!\ THIS IS WORK IN PROGRESS /!\
- ----
- 
  '''Related Topics'''
   * MoinMoin:MoinMoinWinCvs

--- 1,4 ----
  '''Related Topics'''
+  * MoinMoin:MoinDev
   * MoinMoin:MoinMoinWinCvs

***************
*** 8,17 ****
  [[TableOfContents]]

! '''TODO'''
!  * Collect existing info from the MoinMoin wiki pages
!  * Explain extension / plugin concept
!  * Start at defining somewhat official APIs (but not before we changed everything to accesses via `request`)
!  * Show how to best create URLs (Page.link_to etc.)
!  * How to use I18N features

  == Contributions ==
--- 6,19 ----
  [[TableOfContents]]

! == Helping with MoinMoin development ==
! 
! MoinMoin would miss quite some features were it not for the help of some of its users. What you can do to improve MoinMoin, also for your own benefit:
!  * develop new extensions (macros, actions, processors, parsers)
!  * run the CVS version and help testing the new features
!  * test MoinMoin on a certain platform, or with certain Python versions
!  * help with the translation efforts, especially adding new languages
!  * ...
! 
! In any case, you should subscribe to the [http://lists.sourceforge.net/lists/listinfo/moin-devel MoinMoin Developer List]. More information on MoinMoin source code and other developer issues can be found in the MoinMoin main wiki, on MoinMoin:MoinDev and its subpages.

  == Contributions ==
***************
*** 29,79 ****
  Contributors are encouraged to send updates... 

- == Extension guidelines ==
- These are the rules that govern MoinMoin development:
-  * All extensions to or modifications of the original MoinMoin:WikiMarkup should be kept compatible and in the spirit of the MoinMoin:OriginalWiki. Example: [http://... text] shows up literally, i.e. no information is lost when cut&pasting to another Wiki.
-  * Be portable at all times, at the very least to Win32 and Unix.
-  * Keep the simple nature of page storage, if there are performance issues, add transparent caching / indexing.
-  * Contributions without accompanying user documentation for the feature are not acceptable. 
-  * Contributions without sufficient docstrings and comments are not acceptable. Sufficient means on the level of the existing code base, i.e. higher than you might be used to. ;)
- 
- 
- == CVS structure ==
- 
- For historical reasons, the ''virtual'' CVS module "`moin`" combines the "`dist`" and the "`MoinMoin`" module; "`moin`" is the only module you should check out.
- 
- 
- == Tour of the most important modules ==
- 
-  wikiaction.py:: HelpOnActions lists all the querystrings that are handled by this module.
- 
- == Storage ==
- 
-  edit log:: ...
-  event log:: ...
-  pages:: ...
-  attachments:: ...
-  backups:: ...
-  user data:: ...
-  caching:: ...
- 
- == Creating a release ==
- 
- This describes how to create a release tarball for MoinMoin. It's of minor interest to anyone except MoinMoin:JürgenHermann. :)
- 
-  1. Commit any pending code changes.
-  1. Commit the current status of the MoinMoin wiki (especially the help pages).
-  1. `make install-docs`
-  1. Validate the CHANGES file (insert current date and new version number).
-  1. Tag the repository: {{{
- cvs tag rel-MAJOR-MINOR}}}
-  1. Create an export directory: {{{
- cvs -z3 -d :pserver:anonymous at cvs.moin.sourceforge.net:/cvsroot/moin export -r HEAD moin
- cd moin
- python setup.py sdist
- }}}
-  1. Upload the tarball (or zip):
-     * [http://sourceforge.net/project/admin/editpackages.php?group_id=8482 SourceForge / Project Admin / Release Files]
-     * Follow the forms
-     * See also [http://sfdocs.sourceforge.net/sfdocs/display_topic.php?topicid=22 Making File Releases]
-  1. Download from MoinMoin:SourceForge and give it a test run.
--- 31,39 ----
  Contributors are encouraged to send updates... 

+ Another source of user contributions are the 
+ MoinMoin:ActionMarket,
+ MoinMoin:MacroMarket,
+ MoinMoin:ParserMarket, and
+ MoinMoin:ProcessorMarket
+ pages.