From 52c6de5a2352b8f6339614d9c2d155ee54422d96 Mon Sep 17 00:00:00 2001 From: helge Date: Tue, 12 Apr 2005 17:19:15 +0000 Subject: [PATCH] added .api to manpage converter, generated manpages git-svn-id: http://svn.opengroupware.org/SOPE/trunk@730 e4a50df8-12e2-0310-a44c-efbce7f8a7e3 --- sope-appserver/NGObjWeb/ChangeLog | 9 + sope-appserver/NGObjWeb/GNUmakefile | 3 +- sope-appserver/NGObjWeb/README | 15 +- sope-appserver/NGObjWeb/Version | 2 +- sope-appserver/NGObjWeb/doc/Makefile | 16 ++ sope-appserver/NGObjWeb/doc/WOActionURL.3 | 48 +++++ sope-appserver/NGObjWeb/doc/WOBody.3 | 44 ++++ sope-appserver/NGObjWeb/doc/WOBrowser.3 | 50 +++++ sope-appserver/NGObjWeb/doc/WOCheckBox.3 | 45 +++++ sope-appserver/NGObjWeb/doc/WOCheckBoxList.3 | 48 +++++ .../NGObjWeb/doc/WOComponentReference.3 | 38 ++++ sope-appserver/NGObjWeb/doc/WOConditional.3 | 37 ++++ .../NGObjWeb/doc/WOEmbeddedObject.3 | 50 +++++ sope-appserver/NGObjWeb/doc/WOEntity.3 | 36 ++++ sope-appserver/NGObjWeb/doc/WOFileUpload.3 | 41 ++++ sope-appserver/NGObjWeb/doc/WOForm.3 | 49 +++++ sope-appserver/NGObjWeb/doc/WOFrame.3 | 47 +++++ .../NGObjWeb/doc/WOGenericContainer.3 | 36 ++++ .../NGObjWeb/doc/WOGenericElement.3 | 36 ++++ sope-appserver/NGObjWeb/doc/WOHiddenField.3 | 39 ++++ sope-appserver/NGObjWeb/doc/WOHyperlink.3 | 60 ++++++ sope-appserver/NGObjWeb/doc/WOIFrame.3 | 48 +++++ sope-appserver/NGObjWeb/doc/WOImage.3 | 52 +++++ sope-appserver/NGObjWeb/doc/WOImageButton.3 | 62 ++++++ sope-appserver/NGObjWeb/doc/WOJavaScript.3 | 43 ++++ sope-appserver/NGObjWeb/doc/WOMetaRefresh.3 | 52 +++++ sope-appserver/NGObjWeb/doc/WONestedList.3 | 52 +++++ sope-appserver/NGObjWeb/doc/WOPasswordField.3 | 40 ++++ sope-appserver/NGObjWeb/doc/WOPopUpButton.3 | 54 +++++ sope-appserver/NGObjWeb/doc/WOQuickTime.3 | 68 +++++++ sope-appserver/NGObjWeb/doc/WORadioButton.3 | 45 +++++ .../NGObjWeb/doc/WORadioButtonList.3 | 47 +++++ sope-appserver/NGObjWeb/doc/WORepetition.3 | 46 +++++ sope-appserver/NGObjWeb/doc/WOResetButton.3 | 39 ++++ sope-appserver/NGObjWeb/doc/WOResourceURL.3 | 48 +++++ sope-appserver/NGObjWeb/doc/WOSetCursor.3 | 36 ++++ sope-appserver/NGObjWeb/doc/WOString.3 | 49 +++++ sope-appserver/NGObjWeb/doc/WOSubmitButton.3 | 51 +++++ .../NGObjWeb/doc/WOSwitchComponent.3 | 36 ++++ sope-appserver/NGObjWeb/doc/WOText.3 | 49 +++++ sope-appserver/NGObjWeb/doc/WOTextField.3 | 48 +++++ sope-appserver/NGObjWeb/doc/WOVBScript.3 | 43 ++++ sope-appserver/NGObjWeb/woapi2man.py | 189 ++++++++++++++++++ 43 files changed, 1941 insertions(+), 5 deletions(-) create mode 100644 sope-appserver/NGObjWeb/doc/Makefile create mode 100644 sope-appserver/NGObjWeb/doc/WOActionURL.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOBody.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOBrowser.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOCheckBox.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOCheckBoxList.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOComponentReference.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOConditional.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOEmbeddedObject.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOEntity.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOFileUpload.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOForm.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOFrame.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOGenericContainer.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOGenericElement.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOHiddenField.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOHyperlink.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOIFrame.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOImage.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOImageButton.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOJavaScript.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOMetaRefresh.3 create mode 100644 sope-appserver/NGObjWeb/doc/WONestedList.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOPasswordField.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOPopUpButton.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOQuickTime.3 create mode 100644 sope-appserver/NGObjWeb/doc/WORadioButton.3 create mode 100644 sope-appserver/NGObjWeb/doc/WORadioButtonList.3 create mode 100644 sope-appserver/NGObjWeb/doc/WORepetition.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOResetButton.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOResourceURL.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOSetCursor.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOString.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOSubmitButton.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOSwitchComponent.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOText.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOTextField.3 create mode 100644 sope-appserver/NGObjWeb/doc/WOVBScript.3 create mode 100755 sope-appserver/NGObjWeb/woapi2man.py diff --git a/sope-appserver/NGObjWeb/ChangeLog b/sope-appserver/NGObjWeb/ChangeLog index 7595a264..95fd2616 100644 --- a/sope-appserver/NGObjWeb/ChangeLog +++ b/sope-appserver/NGObjWeb/ChangeLog @@ -1,3 +1,12 @@ +2005-04-12 Helge Hess + + * v4.5.151 + + * added generated manpages for all .api files + + * added woapi2man.py, a tool to generate man-pages from .api XML files + (used for describing the bindings of dynamic elements) + 2005-04-12 Helge Hess * v4.5.150 diff --git a/sope-appserver/NGObjWeb/GNUmakefile b/sope-appserver/NGObjWeb/GNUmakefile index c41d327f..0572a218 100644 --- a/sope-appserver/NGObjWeb/GNUmakefile +++ b/sope-appserver/NGObjWeb/GNUmakefile @@ -34,7 +34,8 @@ libNGObjWeb_RESOURCES = \ DAVPropMap.plist \ FHS_MANPAGES += \ - sope-ngobjweb-defaults.5 + sope-ngobjweb-defaults.5 \ + doc/*.3 libNGObjWeb_HEADER_FILES = \ NGObjWebDecls.h \ diff --git a/sope-appserver/NGObjWeb/README b/sope-appserver/NGObjWeb/README index 70ecc5d4..3f0b41a8 100644 --- a/sope-appserver/NGObjWeb/README +++ b/sope-appserver/NGObjWeb/README @@ -1,8 +1,6 @@ -# $Id$ - NGObjWeb Library Part of the SKYRiX Object Publishing Environment - Copyright (C) 2000-2003 SKYRIX Software AG - http://www.skyrix.com/ + Copyright (C) 2000-2005 SKYRIX Software AG - http://www.skyrix.com/ Subprojects =========== @@ -71,6 +69,17 @@ Class-Hierachy Log Topics + +Localization +============ + +From WO 3.5 to WO 4.0 the localization mechanism was changed. Prior 4.0 the +language.lproj was stored inside the .wo wrapper. Afterwards its the other way +around. + http://developer.apple.com/documentation/LegacyTechnologies/WebObjects/ + WebObjects_4.0/System/Documentation/Developer/WebObjects/DeltaDoc/ + NewInWO4.051.html#28715 + -- Helge Hess (helge.hess@skyrix.com) SKYRIX Software AG, 2003-01-06 diff --git a/sope-appserver/NGObjWeb/Version b/sope-appserver/NGObjWeb/Version index 5bd2e110..74e87125 100644 --- a/sope-appserver/NGObjWeb/Version +++ b/sope-appserver/NGObjWeb/Version @@ -1,6 +1,6 @@ # version file -SUBMINOR_VERSION:=150 +SUBMINOR_VERSION:=151 # v4.5.122 requires libNGExtensions v4.5.153 # v4.5.91 requires libNGExtensions v4.5.134 diff --git a/sope-appserver/NGObjWeb/doc/Makefile b/sope-appserver/NGObjWeb/doc/Makefile new file mode 100644 index 00000000..80ccc2db --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/Makefile @@ -0,0 +1,16 @@ +# makefile to generate manpages from .api files + +-include ../../../config.make +include ../../../Version +include ../Version + +API2MAN = ../woapi2man.py +SECTION = 3 + +all :: regenerate + +regenerate :: + for apifile in ../DynamicElements/*.api; do \ + OUTFILE="`basename $$apifile | sed s/\\.api/.3/g`"; \ + $(API2MAN) $$apifile $$SECTION $(MAJOR_VERSION) $(MINOR_VERSION) $(SUBMINOR_VERSION) >$$OUTFILE; \ + done diff --git a/sope-appserver/NGObjWeb/doc/WOActionURL.3 b/sope-appserver/NGObjWeb/doc/WOActionURL.3 new file mode 100644 index 00000000..5c992124 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOActionURL.3 @@ -0,0 +1,48 @@ +.TH WOActionURL 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOActionURL.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOActionURL + +.SH SYNOPSIS +.B WOActionURL +{ pageName; action; actionClass; directActionName; fragmentIdentifier; queryDictionary; otherTagString; } + +.SH VALIDATION +Either one of 'action', or 'pagename' may be bound, or either or both of 'actionclass' and 'directactionname' may be bound + +.SH BINDINGS +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP actionClass +Kind: Direct Action Classes +.IP directActionName +Kind: Direct Actions +.IP fragmentIdentifier +.IP queryDictionary +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOBody.3 b/sope-appserver/NGObjWeb/doc/WOBody.3 new file mode 100644 index 00000000..96e68fb9 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOBody.3 @@ -0,0 +1,44 @@ +.TH WOBody 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOBody.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOBody + +.SH SYNOPSIS +.B WOBody +{ filename; framework; src; value; otherTagString; } + +.SH VALIDATION +\'filename' must be bound when 'framework' is bound + +.SH BINDINGS +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP src +.IP value +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOBrowser.3 b/sope-appserver/NGObjWeb/doc/WOBrowser.3 new file mode 100644 index 00000000..e9093709 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOBrowser.3 @@ -0,0 +1,50 @@ +.TH WOBrowser 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOBrowser.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOBrowser + +.SH SYNOPSIS +.B WOBrowser +{ list; item; selections; displayString; name; value; disabled; multiple; size; otherTagString; singleSelection; } + +.SH VALIDATION +\'list' must not be a constant +\'singleselection' and 'selections' cannot both be bound + +.SH BINDINGS +.IP list +.IP item +.IP selections +.IP displayString +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP multiple +.IP size +.IP otherTagString +.IP singleSelection + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOCheckBox.3 b/sope-appserver/NGObjWeb/doc/WOCheckBox.3 new file mode 100644 index 00000000..d7966c50 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOCheckBox.3 @@ -0,0 +1,45 @@ +.TH WOCheckBox 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOCheckBox.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOCheckBox + +.SH SYNOPSIS +.B WOCheckBox +{ selection; checked; name; value; disabled; otherTagString; } + +.SH VALIDATION +Exactly one of 'checked' or 'value' must be bound +If either 'selection' or 'value' is bound, then both must be bound + +.SH BINDINGS +.IP selection +.IP checked +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOCheckBoxList.3 b/sope-appserver/NGObjWeb/doc/WOCheckBoxList.3 new file mode 100644 index 00000000..88838b5d --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOCheckBoxList.3 @@ -0,0 +1,48 @@ +.TH WOCheckBoxList 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOCheckBoxList.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOCheckBoxList + +.SH SYNOPSIS +.B WOCheckBoxList +{ list; item; index; selections; prefix; suffix; name; value; disabled; otherTagString; } + +.SH VALIDATION +\'list' must not be a constant + +.SH BINDINGS +.IP list +.IP item +.IP index +.IP selections +.IP prefix +.IP suffix +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOComponentReference.3 b/sope-appserver/NGObjWeb/doc/WOComponentReference.3 new file mode 100644 index 00000000..5b859c23 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOComponentReference.3 @@ -0,0 +1,38 @@ +.TH WOComponentReference 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOComponentReference.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOComponentReference + +.SH SYNOPSIS +.B WOComponentReference +{ component; } + +.SH VALIDATION +\'component' is required + +.SH BINDINGS +.IP component + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOConditional.3 b/sope-appserver/NGObjWeb/doc/WOConditional.3 new file mode 100644 index 00000000..e02610c2 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOConditional.3 @@ -0,0 +1,37 @@ +.TH WOConditional 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOConditional.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOConditional + +.SH SYNOPSIS +.B WOConditional +{ negate; condition; } + +.SH BINDINGS +.IP negate +The value of 'negate' will be evaluated in a boolean context. +.IP condition + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOEmbeddedObject.3 b/sope-appserver/NGObjWeb/doc/WOEmbeddedObject.3 new file mode 100644 index 00000000..290bc601 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOEmbeddedObject.3 @@ -0,0 +1,50 @@ +.TH WOEmbeddedObject 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOEmbeddedObject.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOEmbeddedObject + +.SH SYNOPSIS +.B WOEmbeddedObject +{ filename; framework; src; value; data; mimeType; key; otherTagString; } + +.SH VALIDATION +Exactly one of 'data', 'filename', 'src', or 'value' must be bound +\'filename' must be bound when 'framework' is bound +\'mimetype' must be bound when 'data' is bound + +.SH BINDINGS +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP src +.IP value +.IP data +.IP mimeType +Kind: MIME Types +.IP key +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOEntity.3 b/sope-appserver/NGObjWeb/doc/WOEntity.3 new file mode 100644 index 00000000..d4179e2d --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOEntity.3 @@ -0,0 +1,36 @@ +.TH WOEntity 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOEntity.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOEntity + +.SH SYNOPSIS +.B WOEntity +{ name; otherTagString; } + +.SH BINDINGS +.IP name +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOFileUpload.3 b/sope-appserver/NGObjWeb/doc/WOFileUpload.3 new file mode 100644 index 00000000..3d8afadd --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOFileUpload.3 @@ -0,0 +1,41 @@ +.TH WOFileUpload 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOFileUpload.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOFileUpload + +.SH SYNOPSIS +.B WOFileUpload +{ data; filePath; name; value; disabled; otherTagString; } + +.SH BINDINGS +.IP data +.IP filePath +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOForm.3 b/sope-appserver/NGObjWeb/doc/WOForm.3 new file mode 100644 index 00000000..a3e8c36f --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOForm.3 @@ -0,0 +1,49 @@ +.TH WOForm 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOForm.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOForm + +.SH SYNOPSIS +.B WOForm +{ action; href; pageName; queryDictionary; actionClass; directActionName; otherTagString; method; } + +.SH VALIDATION +Either one of 'action', 'href' or 'pagename' may be bound, or one or both of 'actionclass' or 'directactionname' may be bound + +.SH BINDINGS +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP href +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP queryDictionary +.IP actionClass +Kind: Direct Action Classes +.IP directActionName +Kind: Direct Actions +.IP otherTagString +.IP method + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOFrame.3 b/sope-appserver/NGObjWeb/doc/WOFrame.3 new file mode 100644 index 00000000..48fe5d40 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOFrame.3 @@ -0,0 +1,47 @@ +.TH WOFrame 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOFrame.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOFrame + +.SH SYNOPSIS +.B WOFrame +{ pageName; src; value; actionClass; directActionName; queryDictionary; otherTagString; } + +.SH VALIDATION +Either one of 'pagename', 'src', or 'value' may be bound, or either or both of 'actionclass' and 'directactionname' may be bound + +.SH BINDINGS +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP src +.IP value +.IP actionClass +Kind: Direct Action Classes +.IP directActionName +Kind: Direct Actions +.IP queryDictionary +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOGenericContainer.3 b/sope-appserver/NGObjWeb/doc/WOGenericContainer.3 new file mode 100644 index 00000000..bb611a67 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOGenericContainer.3 @@ -0,0 +1,36 @@ +.TH WOGenericContainer 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOGenericContainer.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOGenericContainer + +.SH SYNOPSIS +.B WOGenericContainer +{ elementName; otherTagString; } + +.SH BINDINGS +.IP elementName +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOGenericElement.3 b/sope-appserver/NGObjWeb/doc/WOGenericElement.3 new file mode 100644 index 00000000..fdc17918 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOGenericElement.3 @@ -0,0 +1,36 @@ +.TH WOGenericElement 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOGenericElement.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOGenericElement + +.SH SYNOPSIS +.B WOGenericElement +{ elementName; otherTagString; } + +.SH BINDINGS +.IP elementName +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOHiddenField.3 b/sope-appserver/NGObjWeb/doc/WOHiddenField.3 new file mode 100644 index 00000000..c214d3c4 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOHiddenField.3 @@ -0,0 +1,39 @@ +.TH WOHiddenField 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOHiddenField.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOHiddenField + +.SH SYNOPSIS +.B WOHiddenField +{ name; value; disabled; otherTagString; } + +.SH BINDINGS +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOHyperlink.3 b/sope-appserver/NGObjWeb/doc/WOHyperlink.3 new file mode 100644 index 00000000..3f02bc59 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOHyperlink.3 @@ -0,0 +1,60 @@ +.TH WOHyperlink 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOHyperlink.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOHyperlink + +.SH SYNOPSIS +.B WOHyperlink +{ href; pageName; action; directActionName; actionClass; fragmentIdentifier; string; target; disabled; queryDictionary; otherTagString; filename; disabledFilename; framework; src; } + +.SH VALIDATION +Either one of 'action', 'href', or 'pagename' may be bound, or either or both of 'actionclass' and 'directactionname' may be bound + +.SH BINDINGS +.IP href +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP directActionName +Kind: Direct Actions +.IP actionClass +Kind: Direct Action Classes +.IP fragmentIdentifier +.IP string +.IP target +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP queryDictionary +.IP otherTagString +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP disabledFilename +The value of 'disabledFilename' refers to a resource which will be looked up using the WOResourceManager. +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP src + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOIFrame.3 b/sope-appserver/NGObjWeb/doc/WOIFrame.3 new file mode 100644 index 00000000..446c8375 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOIFrame.3 @@ -0,0 +1,48 @@ +.TH WOIFrame 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOIFrame.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOIFrame + +.SH SYNOPSIS +.B WOIFrame +{ pageName; src; value; filename; directActionName; actionClass; queryDictionary; otherTagString; } + +.SH VALIDATION +Either one of 'pagename', 'src', 'value' or 'directactionname' may be bound, or either or both of 'actionclass' and 'directactionname', or both of 'value' and 'filename' may be bound + +.SH BINDINGS +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP src +.IP value +.IP filename +.IP directActionName +Kind: Direct Actions +.IP actionClass +Kind: Direct Action Classes +.IP queryDictionary +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOImage.3 b/sope-appserver/NGObjWeb/doc/WOImage.3 new file mode 100644 index 00000000..79391d6e --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOImage.3 @@ -0,0 +1,52 @@ +.TH WOImage 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOImage.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOImage + +.SH SYNOPSIS +.B WOImage +{ framework; mimeType; key; data; src; alt; border; filename; otherTagString; value; } + +.SH VALIDATION +Exactly one of 'data', 'filename', 'src' or 'value' must be bound +\'filename' must be bound when 'framework' is bound +\'mimetype' must be bound when 'data' is bound + +.SH BINDINGS +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP mimeType +Kind: MIME Types +.IP key +.IP data +.IP src +.IP alt +.IP border +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP otherTagString +.IP value + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOImageButton.3 b/sope-appserver/NGObjWeb/doc/WOImageButton.3 new file mode 100644 index 00000000..b49524ea --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOImageButton.3 @@ -0,0 +1,62 @@ +.TH WOImageButton 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOImageButton.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOImageButton + +.SH SYNOPSIS +.B WOImageButton +{ pageName; action; directActionName; actionClass; src; filename; framework; x; y; queryDictionary; name; value; disabled; otherTagString; disabledFilename; } + +.SH VALIDATION +Either 'action', or one or both of 'actionclass' or 'directactionname' may be bound +Exactly one of'filename', 'src', or 'value' must be bound +\'filename' must be bound when 'framework' is bound + +.SH BINDINGS +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP directActionName +Kind: Direct Actions +.IP actionClass +Kind: Direct Action Classes +.IP src +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP x +.IP y +.IP queryDictionary +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString +.IP disabledFilename +The value of 'disabledFilename' refers to a resource which will be looked up using the WOResourceManager. + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOJavaScript.3 b/sope-appserver/NGObjWeb/doc/WOJavaScript.3 new file mode 100644 index 00000000..7fafdf30 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOJavaScript.3 @@ -0,0 +1,43 @@ +.TH WOJavaScript 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOJavaScript.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOJavaScript + +.SH SYNOPSIS +.B WOJavaScript +{ hideInComment; scriptSource; scriptString; scriptFile; otherTagString; } + +.SH VALIDATION +One of 'scriptfile', 'scriptsource', or 'scriptstring' must be bound + +.SH BINDINGS +.IP hideInComment +The value of 'hideInComment' will be evaluated in a boolean context. +.IP scriptSource +.IP scriptString +.IP scriptFile +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOMetaRefresh.3 b/sope-appserver/NGObjWeb/doc/WOMetaRefresh.3 new file mode 100644 index 00000000..411a89f4 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOMetaRefresh.3 @@ -0,0 +1,52 @@ +.TH WOMetaRefresh 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOMetaRefresh.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOMetaRefresh + +.SH SYNOPSIS +.B WOMetaRefresh +{ action; href; pageName; directActionName; actionClass; disabled; fragmentIdentifier; timeout; queryDictionary; otherTagString; } + +.SH VALIDATION +Either one of 'action', 'href', or 'pagename' may be bound, or either or both of 'actionclass' and 'directactionname' may be bound + +.SH BINDINGS +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP href +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP directActionName +Kind: Direct Actions +.IP actionClass +Kind: Direct Action Classes +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP fragmentIdentifier +.IP timeout +.IP queryDictionary +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WONestedList.3 b/sope-appserver/NGObjWeb/doc/WONestedList.3 new file mode 100644 index 00000000..5e78e057 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WONestedList.3 @@ -0,0 +1,52 @@ +.TH WONestedList 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WONestedList.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WONestedList + +.SH SYNOPSIS +.B WONestedList +{ action; list; item; value; sublist; action; selection; index; level; isOrdered; prefix; suffix; otherTagString; } + +.SH VALIDATION +\'list' must not be a constant + +.SH BINDINGS +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP list +.IP item +.IP value +.IP sublist +.IP action +Kind: Direct Actions +.IP selection +.IP index +.IP level +.IP isOrdered +.IP prefix +.IP suffix +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOPasswordField.3 b/sope-appserver/NGObjWeb/doc/WOPasswordField.3 new file mode 100644 index 00000000..211265ec --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOPasswordField.3 @@ -0,0 +1,40 @@ +.TH WOPasswordField 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOPasswordField.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOPasswordField + +.SH SYNOPSIS +.B WOPasswordField +{ name; value; disabled; otherTagString; size; } + +.SH BINDINGS +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString +.IP size + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOPopUpButton.3 b/sope-appserver/NGObjWeb/doc/WOPopUpButton.3 new file mode 100644 index 00000000..bab5d3c5 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOPopUpButton.3 @@ -0,0 +1,54 @@ +.TH WOPopUpButton 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOPopUpButton.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOPopUpButton + +.SH SYNOPSIS +.B WOPopUpButton +{ list; item; selection; displayString; noSelectionString; selectedValue; escapeHTML; name; value; disabled; itemGroup; otherTagString; } + +.SH VALIDATION +\'list' must not be a constant +\'item' may not be a constant when 'displaystring' or 'value' is bound +\'item' must be bound when 'displaystring' or 'value' is bound +\'selectedvalue' and 'selection' cannot both be bound + +.SH BINDINGS +.IP list +.IP item +.IP selection +.IP displayString +.IP noSelectionString +.IP selectedValue +.IP escapeHTML +The value of 'escapeHTML' will be evaluated in a boolean context. +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP itemGroup +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOQuickTime.3 b/sope-appserver/NGObjWeb/doc/WOQuickTime.3 new file mode 100644 index 00000000..9b58fd6c --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOQuickTime.3 @@ -0,0 +1,68 @@ +.TH WOQuickTime 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOQuickTime.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOQuickTime + +.SH SYNOPSIS +.B WOQuickTime +{ filename; framework; src; action; href; pageName; prefixHost; width; height; pluginsPage; hotspotList; selection; bgcolor; target; volume; pan; tilt; fov; node; correction; cache; autoplay; hidden; playEveryFrame; controller; otherTagString; } + +.SH BINDINGS +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP src +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP href +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP prefixHost +.IP width +.IP height +.IP pluginsPage +.IP hotspotList +.IP selection +.IP bgcolor +.IP target +.IP volume +.IP pan +.IP tilt +.IP fov +.IP node +.IP correction +.IP cache +The value of 'cache' will be evaluated in a boolean context. +.IP autoplay +The value of 'autoplay' will be evaluated in a boolean context. +.IP hidden +.IP playEveryFrame +The value of 'playEveryFrame' will be evaluated in a boolean context. +.IP controller +The value of 'controller' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WORadioButton.3 b/sope-appserver/NGObjWeb/doc/WORadioButton.3 new file mode 100644 index 00000000..e1599f94 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WORadioButton.3 @@ -0,0 +1,45 @@ +.TH WORadioButton 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WORadioButton.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WORadioButton + +.SH SYNOPSIS +.B WORadioButton +{ selection; checked; name; value; disabled; otherTagString; } + +.SH VALIDATION +Exactly one of 'checked' or 'value' must be bound +If either 'selection' or 'value' is bound, then both must be bound + +.SH BINDINGS +.IP selection +.IP checked +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WORadioButtonList.3 b/sope-appserver/NGObjWeb/doc/WORadioButtonList.3 new file mode 100644 index 00000000..ddb18bbb --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WORadioButtonList.3 @@ -0,0 +1,47 @@ +.TH WORadioButtonList 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WORadioButtonList.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WORadioButtonList + +.SH SYNOPSIS +.B WORadioButtonList +{ list; item; index; selection; prefix; suffix; name; value; disabled; } + +.SH VALIDATION +\'list' must not be a constant + +.SH BINDINGS +.IP list +.IP item +.IP index +.IP selection +.IP prefix +.IP suffix +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WORepetition.3 b/sope-appserver/NGObjWeb/doc/WORepetition.3 new file mode 100644 index 00000000..874ea021 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WORepetition.3 @@ -0,0 +1,46 @@ +.TH WORepetition 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WORepetition.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WORepetition + +.SH SYNOPSIS +.B WORepetition +{ item; list; count; index; identifier; startIndex; separator; } + +.SH VALIDATION +\'list' must not be a constant +Exactly one of 'count' or 'list' must be bound +\'item' must be bound when 'list' is bound + +.SH BINDINGS +.IP item +.IP list +.IP count +.IP index +.IP identifier +.IP startIndex +.IP separator + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOResetButton.3 b/sope-appserver/NGObjWeb/doc/WOResetButton.3 new file mode 100644 index 00000000..60dcc4d5 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOResetButton.3 @@ -0,0 +1,39 @@ +.TH WOSubmitButton 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOResetButton.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOSubmitButton + +.SH SYNOPSIS +.B WOSubmitButton +{ name; value; disabled; otherTagString; } + +.SH BINDINGS +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOResourceURL.3 b/sope-appserver/NGObjWeb/doc/WOResourceURL.3 new file mode 100644 index 00000000..b4856b3a --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOResourceURL.3 @@ -0,0 +1,48 @@ +.TH WOResourceURL 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOResourceURL.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOResourceURL + +.SH SYNOPSIS +.B WOResourceURL +{ filename; framework; data; mimeType; key; otherTagString; } + +.SH VALIDATION +Exactly one of 'data' or 'filename' must be bound +\'filename' must be bound when 'framework' is bound +\'mimetype' must be bound when 'data' is bound + +.SH BINDINGS +.IP filename +The value of 'filename' refers to a resource which will be looked up using the WOResourceManager. +.IP framework +The value of 'framework' must be the name of a framework or bundle to be used for resource lookups. +.IP data +.IP mimeType +Kind: MIME Types +.IP key +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOSetCursor.3 b/sope-appserver/NGObjWeb/doc/WOSetCursor.3 new file mode 100644 index 00000000..73310786 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOSetCursor.3 @@ -0,0 +1,36 @@ +.TH WOSetCursor 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOSetCursor.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOSetCursor + +.SH SYNOPSIS +.B WOSetCursor +{ object; extraAttributes; } + +.SH BINDINGS +.IP object +.IP extraAttributes + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOString.3 b/sope-appserver/NGObjWeb/doc/WOString.3 new file mode 100644 index 00000000..59585573 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOString.3 @@ -0,0 +1,49 @@ +.TH WOString 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOString.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOString + +.SH SYNOPSIS +.B WOString +{ value; escapeHTML; numberformat; dateformat; formatter; valueWhenEmpty; insertBR; style; } + +.SH VALIDATION +No more than one of 'dateformat', 'numberformat', or 'formatter' may be bound + +.SH BINDINGS +.IP value +.IP escapeHTML +The value of 'escapeHTML' will be evaluated in a boolean context. +.IP numberformat +Kind: Number Format Strings +.IP dateformat +Kind: Date Format Strings +.IP formatter +.IP valueWhenEmpty +.IP insertBR +The value of 'insertBR' will be evaluated in a boolean context. +.IP style + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOSubmitButton.3 b/sope-appserver/NGObjWeb/doc/WOSubmitButton.3 new file mode 100644 index 00000000..9b78f864 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOSubmitButton.3 @@ -0,0 +1,51 @@ +.TH WOSubmitButton 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOSubmitButton.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOSubmitButton + +.SH SYNOPSIS +.B WOSubmitButton +{ action; pageName; actionClass; directActionName; queryDictionary; name; value; disabled; otherTagString; } + +.SH VALIDATION +Either one of 'action', 'href', or 'pagename' may be bound, or either or both of 'actionclass' and 'directactionname' may be bound + +.SH BINDINGS +.IP action +The 'action' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object). +.IP pageName +The value of 'pageName' will be used to lookup a WOComponent page. +.IP actionClass +Kind: Direct Action Classes +.IP directActionName +Kind: Direct Actions +.IP queryDictionary +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOSwitchComponent.3 b/sope-appserver/NGObjWeb/doc/WOSwitchComponent.3 new file mode 100644 index 00000000..203e5b3d --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOSwitchComponent.3 @@ -0,0 +1,36 @@ +.TH WOSwitchComponent 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOSwitchComponent.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOSwitchComponent + +.SH SYNOPSIS +.B WOSwitchComponent +{ WOComponentName; otherTagString; } + +.SH BINDINGS +.IP WOComponentName +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOText.3 b/sope-appserver/NGObjWeb/doc/WOText.3 new file mode 100644 index 00000000..7fa6a75f --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOText.3 @@ -0,0 +1,49 @@ +.TH WOTextField 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOText.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOTextField + +.SH SYNOPSIS +.B WOTextField +{ name; value; disabled; rows; cols; numberformat; dateformat; formatter; otherTagString; } + +.SH VALIDATION +No more than one of 'dateformat', 'numberformat', or 'formatter' may be bound + +.SH BINDINGS +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP rows +.IP cols +.IP numberformat +Kind: Number Format Strings +.IP dateformat +Kind: Date Format Strings +.IP formatter +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOTextField.3 b/sope-appserver/NGObjWeb/doc/WOTextField.3 new file mode 100644 index 00000000..bd44e5db --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOTextField.3 @@ -0,0 +1,48 @@ +.TH WOTextField 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOTextField.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOTextField + +.SH SYNOPSIS +.B WOTextField +{ name; value; disabled; numberformat; dateformat; formatter; otherTagString; size; } + +.SH VALIDATION +No more than one of 'dateformat', 'numberformat', or 'formatter' may be bound + +.SH BINDINGS +.IP name +.IP value +.IP disabled +The value of 'disabled' will be evaluated in a boolean context. +.IP numberformat +Kind: Number Format Strings +.IP dateformat +Kind: Date Format Strings +.IP formatter +.IP otherTagString +.IP size + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/doc/WOVBScript.3 b/sope-appserver/NGObjWeb/doc/WOVBScript.3 new file mode 100644 index 00000000..ec3431a3 --- /dev/null +++ b/sope-appserver/NGObjWeb/doc/WOVBScript.3 @@ -0,0 +1,43 @@ +.TH WOVBScript 3 "April 2005" "SOPE" "SOPE Dynamic Element Reference" +.\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\" ../DynamicElements/WOVBScript.api +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" ==================================================================== +.\" +.\" Copyright (C) 2005 SKYRIX Software AG. All rights reserved. +.\" +.\" Check the COPYING file for further information. +.\" +.\" Created with the help of: +.\" http://www.schweikhardt.net/man_page_howto.html +.\" + +.SH NAME +WOVBScript + +.SH SYNOPSIS +.B WOVBScript +{ hideInComment; scriptSource; scriptString; scriptFile; otherTagString; } + +.SH VALIDATION +One of 'scriptfile', 'scriptsource', or 'scriptstring' must be bound + +.SH BINDINGS +.IP hideInComment +The value of 'hideInComment' will be evaluated in a boolean context. +.IP scriptSource +.IP scriptString +.IP scriptFile +.IP otherTagString + +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ + +.SH AUTHOR +The SOPE community . + +.SH SEE ALSO +.BR sope-ngobjweb-defaults + diff --git a/sope-appserver/NGObjWeb/woapi2man.py b/sope-appserver/NGObjWeb/woapi2man.py new file mode 100755 index 00000000..397945c4 --- /dev/null +++ b/sope-appserver/NGObjWeb/woapi2man.py @@ -0,0 +1,189 @@ +#!/usr/bin/python + +import sys, time, xml.dom.minidom + +# templates + +MANUAL="SOPE Dynamic Element Reference" +COPYRIGHT="SKYRIX Software AG" + +HEADER=""".TH %(element)s %(section)i "%(month)s %(year)s" "SOPE" "%(manual)s" +.\\" DO NOT EDIT: this file got autogenerated using woapi2man from: +.\\" %(file)s +.\\" +.\\" Copyright (C) %(year)s %(copy)s. All rights reserved. +.\\" ==================================================================== +.\\" +.\\" Copyright (C) %(year)s %(copy)s. All rights reserved. +.\\" +.\\" Check the COPYING file for further information. +.\\" +.\\" Created with the help of: +.\\" http://www.schweikhardt.net/man_page_howto.html +.\\" +""" + +BUGS=""" +.SH BUGS +SOPE related bugs are collected in the OpenGroupware.org Bugzilla: + http://bugzilla.opengroupware.org/ +""" + +AUTHOR=""" +.SH AUTHOR +The SOPE community . +""" + +SEEALSO=""" +.SH SEE ALSO +.BR sope-ngobjweb-defaults +""" + +FOOTER="\n" + +PASSTHROUGHTEXT="This binding is a pass-through binding.\n" + +# Note: texts may not start with a single quote: ' +DEFAULTSTEXT="Kind: %s\n" +KINDTOTEXT={ + 'Page Names': "The value of '%(name)s' will be used to lookup a WOComponent page.\n", + 'Actions': "The '%(name)s' binding is evaluated as an action (a method which returns a WOComponent or other WOActionResults object).\n", + 'Resources': "The value of '%(name)s' refers to a resource which will be looked up using the WOResourceManager.\n", + 'YES/NO': "The value of '%(name)s' will be evaluated in a boolean context.\n", + 'Frameworks': "The value of '%(name)s' must be the name of a framework or bundle to be used for resource lookups.\n", + +# 'Direct Actions': "The value of '%(name)s' refers to the name of a direct action method.\n", +# 'Direct Action Classes': "The value of '%(name)s' refers to the name of a direct action class.\n" +} + +# processing + +class DOMToManPage: + + def __init__(self, _path, _dom): + self.path = _path + self.dom = _dom + self.out = sys.stdout + + def clear(self): + self.path = None + self.dom.unlink() + self.dom = None + + def printManPageHeader(self, woroot): + self.out.write(HEADER % { + 'file': self.path, + 'element': woroot.getAttribute('class'), + 'section': 3, + 'month': time.strftime("%B"), + 'year': time.strftime("%Y"), + 'manual': MANUAL, + 'copy': COPYRIGHT + }) + + def printManPageName(self, woroot): + self.out.write("\n.SH NAME\n%s\n" % woroot.getAttribute('class')) + + def printManPageBugs(self, woroot): + self.out.write(BUGS) + + def printManPageAuthor(self, woroot): + self.out.write(AUTHOR) + + def printManPageSeeAlso(self, woroot): + self.out.write(SEEALSO) + + def printManPageFooter(self, woroot): + self.out.write(FOOTER) + + def printSynopsis(self, woroot): + self.out.write("\n.SH SYNOPSIS\n") + self.out.write(".B %s\n" % woroot.getAttribute('class')) + self.out.write("{") + for binding in woroot.getElementsByTagName("binding"): + self.out.write(" %s; " % binding.getAttribute('name')) + self.out.write("}\n") + + def escapeText(self, text): + if text[0] == "'": + return "\\" + text + return text + + def getTextForBindingKind(self, binding, kind): + if kind is None: return + if len(kind) == 0: return + if KINDTOTEXT.has_key(kind): + info = { 'kind': kind, + 'name': binding.getAttribute('name') } + s = KINDTOTEXT[kind] + s = s % info + return s + + return DEFAULTSTEXT % ( kind, ) + + def printBindings(self, woroot): + self.out.write("\n.SH BINDINGS\n") + for binding in woroot.getElementsByTagName("binding"): + self.out.write(".IP %s\n" % binding.getAttribute('name')) + s = binding.getAttribute('passthrough') + if (s and s == 'YES'): + self.out.write(PASSTHROUGHTEXT) + s = binding.getAttribute('defaults') + if (s and len(s) > 0): + self.out.write(self.getTextForBindingKind(binding, s)) + + def printValidation(self, woroot): + vals = woroot.getElementsByTagName("validation") + if (vals.length == 0): return + self.out.write("\n.SH VALIDATION\n") + for val in vals: + m = val.getAttribute('message') + if not m: continue + if len(m) == 0: continue + self.out.write("%s\n" % self.escapeText(m.capitalize())) + + def processDOM(self): + woroot = self.dom.getElementsByTagName("wo")[0] + self.printManPageHeader(woroot) + self.printManPageName(woroot) + + self.printSynopsis(woroot) + self.printValidation(woroot) + self.printBindings(woroot) + + self.printManPageBugs(woroot) + self.printManPageAuthor(woroot) + self.printManPageSeeAlso(woroot) + self.printManPageFooter(woroot) + + def processBinding(self, element): + print " check binding", element.getAttribute('name') + + def processValidation(self, element): + print " check validation:", element.getAttribute('message') + + def processWOTag(self, element): + print "check element class", element.getAttribute('class') + + for binding in dom.getElementsByTagName("binding"): + self.processBinding(binding) + for subelem in dom.getElementsByTagName("validation"): + self.processValidation(subelem) + +#class DOMToManPage + +# main function + +path = sys.argv[1] +try: + dom = xml.dom.minidom.parse(path) +except IOError, e: + sys.stderr.write("%s:0: %s\n" % ( path, e )) +except xml.parsers.expat.ExpatError, xmle: + sys.stderr.write("%s:%i: %s\n" % ( path, xmle.lineno, xmle )) +if dom is None: + sys.exit(1) + +cpu = DOMToManPage(path, dom) +cpu.processDOM() +cpu.clear() -- 2.39.5