Difference between revisions of "Uno/Effort/Migrate Documentation"

From Apache OpenOffice Wiki
< Uno
Jump to: navigation, search
(common/man/typenames.html is about binary UNO type names, not about UNOIDL)
m (spell)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Owner: [[KR | Kay Ramme]]<br>
+
Type: [[Uno/Term/Effort|effort]] Owner: [[KR|Kay Ramme]]  Status: 15%
Status: in progress<br>
+
Type: [[Uno/Term/Effort|effort]]<br>
+
  
==Migrate Documentation==
+
Lots of the [[Uno]] documentation are still located on the http://udk.openoffice.org website. As the [[Uno|Uno Wiki]] should be the location for Uno documentation, the documentation needs to move.
Lots of the [[Uno]] documentation are still located on the http://udk.openoffice.org website. As the [[Uno|Uno wiki]] should be the location for Uno documentation, the documentation needs to move.
+
  
===Problem===
+
==Problem==
 
The Uno documentation on http://udk.openoffice.org is accessible by CVS only. Parts of the documentation are outdated or incorrect. No common style has been applied.
 
The Uno documentation on http://udk.openoffice.org is accessible by CVS only. Parts of the documentation are outdated or incorrect. No common style has been applied.
  
===Goal===
+
==Goal==
 
The goal is to move all documentation from http://udk.openoffice.org into the wiki and to provide it to be easy accessible, understandable and consistent.  
 
The goal is to move all documentation from http://udk.openoffice.org into the wiki and to provide it to be easy accessible, understandable and consistent.  
  
 
The documentation on http://udk.openoffice.org  
 
The documentation on http://udk.openoffice.org  
 
* needs to be reviewed and classified,
 
* needs to be reviewed and classified,
* needs to be migrated if still suiteable, either directly, if consistent with the Uno wiki structure, or may needs to be split (e.g. to [[Uno/Binary|binary Uno]] and [[Uno/Java|Java Uno]]),
+
* needs to be migrated if still suitable, either directly, if consistent with the Uno wiki structure, or may needs to be split (e.g. to [[Uno/Binary|binary Uno]] and [[Uno/Java|Java Uno]]),
 
* needs to be linkified,
 
* needs to be linkified,
 
* while the entries in the CVS need to be deleted after migration.
 
* while the entries in the CVS need to be deleted after migration.
  
===Time Plan===
+
==Time Plan==
 
Open.
 
Open.
  
===Tasks===
+
==Tasks==
 
{|border="1" cellspacing="0" class="wikitable"
 
{|border="1" cellspacing="0" class="wikitable"
 
|- style="background:#efefef;"  
 
|- style="background:#efefef;"  
| Title || State
+
! Title !! State
 
|-
 
|-
| Review&Classify || in progress
+
| Rework [http://udk.openoffice.org UDK] main page || done
 
|-
 
|-
| Migrate || open
+
| Redirect [[Uno]] page to http://udk.opeoffice.org || open - Wiki redirects do not work with external pages - need to find a solution
 
|-
 
|-
| Linkify || open
+
| Migrate documents || in progress (see below)
 
|}
 
|}
  
===Documents State===
+
==Documents State==
 
{|border="1" cellspacing="0" class="wikitable"
 
{|border="1" cellspacing="0" class="wikitable"
 
|- style="background:#efefef;"  
 
|- style="background:#efefef;"  
| Comment || Source || Target || State
+
! Comment !! Source !! Target !! State
 
|-
 
|-
| An Article about bridges. || {{Uno/UDKlink|common/man/bridge.html}} || [[Uno/Article/About Bridges]] || open
+
| OUString with a Buffer - UNO String Construction and Destruction Analysis. || {{Uno/UDK|common/man/concept/string_invest.html}} || [[Uno/Binary/Analysis/String Performance]] || style="background:lightgreen;" | done
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] type library specification || {{Uno/UDKlink|common/man/binspec_typelibrary.html}} || [[Uno/Binary/Spec/Type Library]] || open
+
| [[Uno/Binary|Binary Uno]] specification about bootstrapping. || {{Uno/UDK|common/man/concept/default_bootstrapping.html}} || [[Uno/Binary/Spec/Bootstrapping]] || style="background:lightgreen;" | done
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] IDL types specification || {{Uno/UDKlink|common/man/binspec.html}} || [[Uno/Binary/Spec/IDL Types]] || open
+
| [[Uno/OLE|OLE Bridge]] || {{Uno/UDK|common/man/spec/ole_bridge.html}} || [[Uno/OLE]] || in progress
 
|-
 
|-
| [[Uno/Java|Java Uno]] IDL type mapping || {{Uno/UDKlink|java/man/types.html}} || [[Uno/Java/Spec/IDL Types]] || open
+
| An Article about bridges. || {{Uno/UDK|common/man/bridge.html}} || [[Uno/Article/About Bridges]] || style="background:lightgreen;" | done
 
|-
 
|-
| General information and links to other [[Uno/Java|Java Uno]] related topics. Needs to be reworked and split. || {{Uno/UDKlink|java/man/index.html}} || [[Uno/Java]] || open
+
| [[Uno/Binary|Binary Uno]] type library specification || {{Uno/UDK|common/man/binspec_typelibrary.html}} || [[Uno/Binary/Spec/Type Library]] || open
 
|-
 
|-
| The 'C' language binding. This is more or less dead. || {{Uno/UDKlink|cpp/man/spec/cuno_spec.html}} || [[Uno/C]] || open
+
| [[Uno/Binary|Binary Uno]] IDL types specification || {{Uno/UDK|common/man/binspec.html}} || [[Uno/Binary/Spec/IDL Types]] || open
|-
+
| [[Uno/Remote|Remote Uno]]s standard protocol specification. || {{Uno/UDKlink|common/man/spec/urp.html}} || [[Uno/Remote/Spec/Uno Remote Protocol]] || open
+
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] library unloading article. || {{Uno/UDKlink|common/man/spec/library_unloading.html}} || [[Uno/Article/Binary|Library Unloading]] || open
+
| [[Uno/Java|Java Uno]] IDL type mapping || {{Uno/UDK|java/man/types.html}} || [[Uno/Java/Specifications/Type Mapping]] || style="background:lightgreen;" | done
 +
|-
 +
| General information and links to other [[Uno/Java|Java Uno]] related topics. Needs to be reworked and split. || {{Uno/UDK|java/man/index.html}} || [[Uno/Java]] || open
 +
|-
 +
| The 'C' language binding. This is more or less dead. || {{Uno/UDK|cpp/man/spec/cuno_spec.html}} || [[Uno/C]] || open
 +
|-
 +
| [[Uno/Remote|Remote Uno]]s standard protocol specification. || {{Uno/UDK|common/man/spec/urp.html}} || [[Uno/Remote/Spec/Uno Remote Protocol]] || open
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] article about bootstrapping. || {{Uno/UDKlink|common/man/concept/default_bootstrapping.html}} || [[Uno/Article/Binary/Bootstrapping Uno]] || open
+
| [[Uno/Binary|Binary Uno]] library unloading article. || {{Uno/UDK|common/man/spec/library_unloading.html}} || [[Uno/Article/Binary|Library Unloading]] || open
 
|-
 
|-
| Article about micro deployment. || {{Uno/UDKlink|common/man/concept/micro_deployment.html}} || [[Uno/Article/Micro Deployment]] || open
+
| Article about micro deployment. || {{Uno/UDK|common/man/concept/micro_deployment.html}} || [[Uno/Article/Micro Deployment]] || open
 
|-
 
|-
| Specification of SAL text conversions || {{Uno/UDKlink|cpp/man/spec/textconversion.html}} || [[Uno/Binary/Spec/Text Conversion]] || open
+
| Specification of SAL text conversions || {{Uno/UDK|cpp/man/spec/textconversion.html}} || [[Uno/Binary/Spec/Text Conversion]] || open
 
|-
 
|-
| Specification of URIs in Uno || {{Uno/UDKlink|cpp/man/spec/uris.html}} || [[Uno/Spec/Uniform Resource Identificator]] || open
+
| Specification of URIs in Uno || {{Uno/UDK|cpp/man/spec/uris.html}} || [[Uno/Spec/Uniform Resource Identificator]] || open
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] library versioning schema || {{Uno/UDKlink|common/man/libraryversioning.html}} || [[Uno/Binary/Spec/Library Versioning]] || open
+
| [[Uno/Binary|Binary Uno]] library versioning schema || {{Uno/UDK|common/man/libraryversioning.html}} || [[Uno/Binary/Spec/Library Versioning]] || open
 
|-
 
|-
| [[Uno/Cpp|C++ Uno]] runtime library API design || {{Uno/UDKlink|common/man/apicppclasses.html}} || [[Uno/Cpp/Spec/API Design]] || open
+
| [[Uno/Cpp|C++ Uno]] runtime library API design || {{Uno/UDK|common/man/apicppclasses.html}} || [[Uno/Cpp/Spec/API Design]] || open
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] component naming schema || {{Uno/UDKlink|common/man/componentnames.html}} || [[Uno/Binary/Spec/Component Naming]] || open
+
| [[Uno/Binary|Binary Uno]] component naming schema || {{Uno/UDK|common/man/componentnames.html}} || [[Uno/Binary/Spec/Component Naming]] || open
 
|-
 
|-
| Article about Uno lifecycle concepts || {{Uno/UDKlink|common/man/componentnames.html}} || [[Uno/Article/The Object Lifecycle]] || open
+
| Article about Uno lifecycle concepts || {{Uno/UDK|common/man/componentnames.html}} || [[Uno/Article/The Object Lifecycle]] || open
 
|-
 
|-
| Article about the Uno execution model || {{Uno/UDKlink|common/man/execution.html}} || [[Uno/Article/The Execution Model]] || open
+
| Article about the Uno execution model || {{Uno/UDK|common/man/execution.html}} || [[Uno/Article/The Execution Model]] || open
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] type system specification || {{Uno/UDKlink|common/man/typesystem.html}} || [[Uno/Binary/Spec/Type System]] || open
+
| [[Uno/Binary|Binary Uno]] type system specification || {{Uno/UDK|common/man/typesystem.html}} || [[Uno/Binary/Spec/Type System]] || open
 
|-
 
|-
| [[Uno/Binary|Binary Uno]] type names || {{Uno/UDKlink|common/man/typenames.html}} || [[Uno/Binary/Spec/Type Names]] || open
+
| [[Uno/Binary|Binary Uno]] type names || {{Uno/UDK|common/man/typenames.html}} || [[Uno/Binary/Spec/Type Names]] || open
 
|-
 
|-
| [[Uno]] Component specification || {{Uno/UDKlink|common/man/componentmodel.html}} || [[Uno/Spec/Component]] || open
+
| [[Uno]] Component specification || {{Uno/UDK|common/man/componentmodel.html}} || [[Uno/Spec/Component]] || open
 
|-
 
|-
| Article about remotly bootstrapping Uno/OOo || {{Uno/UDKlink|common/man/spec/transparentofficecomponents.html}} || [[Uno/Article/OOo-Uno Bootstrapping]] || open
+
| Article about remotly bootstrapping Uno/OOo || {{Uno/UDK|common/man/spec/transparentofficecomponents.html}} || [[Uno/Article/OOo-Uno Bootstrapping]] || open
 
|-
 
|-
| Article about the Java vendor framework || {{Uno/UDKlink|common/man/spec/javavendorextension.sxw}} || [[Uno/Article/The Java Vendor Framework]] || open
+
| Article about the Java vendor framework || {{Uno/UDK|common/man/spec/javavendorextension.sxw}} || [[Uno/Article/The Java Vendor Framework]] || open
 
|-
 
|-
| [[Uno/CLI|CLI Uno]] library versioning schema || {{Uno/UDKlink|common/man/spec/assemblyversioning.html}} || [[Uno/CLI/Spec/Library Versioning]] || open
+
| [[Uno/CLI|CLI Uno]] library versioning schema || {{Uno/UDK|common/man/spec/assemblyversioning.html}} || [[Uno/CLI/Spec/Library Versioning]] || open
 
|}
 
|}
  
Line 88: Line 89:
  
  
[[Category:Uno:Effort]]
+
[[Category:Effort]]
 +
[[Category:Uno]]

Latest revision as of 10:15, 21 January 2008

Type: effort Owner: Kay Ramme Status: 15%

Lots of the Uno documentation are still located on the http://udk.openoffice.org website. As the Uno Wiki should be the location for Uno documentation, the documentation needs to move.

Problem

The Uno documentation on http://udk.openoffice.org is accessible by CVS only. Parts of the documentation are outdated or incorrect. No common style has been applied.

Goal

The goal is to move all documentation from http://udk.openoffice.org into the wiki and to provide it to be easy accessible, understandable and consistent.

The documentation on http://udk.openoffice.org

  • needs to be reviewed and classified,
  • needs to be migrated if still suitable, either directly, if consistent with the Uno wiki structure, or may needs to be split (e.g. to binary Uno and Java Uno),
  • needs to be linkified,
  • while the entries in the CVS need to be deleted after migration.

Time Plan

Open.

Tasks

Title State
Rework UDK main page done
Redirect Uno page to http://udk.opeoffice.org open - Wiki redirects do not work with external pages - need to find a solution
Migrate documents in progress (see below)

Documents State

Comment Source Target State
OUString with a Buffer - UNO String Construction and Destruction Analysis. udk/common/man/concept/string_invest.html Uno/Binary/Analysis/String Performance done
Binary Uno specification about bootstrapping. udk/common/man/concept/default_bootstrapping.html Uno/Binary/Spec/Bootstrapping done
OLE Bridge udk/common/man/spec/ole_bridge.html Uno/OLE in progress
An Article about bridges. udk/common/man/bridge.html Uno/Article/About Bridges done
Binary Uno type library specification udk/common/man/binspec_typelibrary.html Uno/Binary/Spec/Type Library open
Binary Uno IDL types specification udk/common/man/binspec.html Uno/Binary/Spec/IDL Types open
Java Uno IDL type mapping udk/java/man/types.html Uno/Java/Specifications/Type Mapping done
General information and links to other Java Uno related topics. Needs to be reworked and split. udk/java/man/index.html Uno/Java open
The 'C' language binding. This is more or less dead. udk/cpp/man/spec/cuno_spec.html Uno/C open
Remote Unos standard protocol specification. udk/common/man/spec/urp.html Uno/Remote/Spec/Uno Remote Protocol open
Binary Uno library unloading article. udk/common/man/spec/library_unloading.html Library Unloading open
Article about micro deployment. udk/common/man/concept/micro_deployment.html Uno/Article/Micro Deployment open
Specification of SAL text conversions udk/cpp/man/spec/textconversion.html Uno/Binary/Spec/Text Conversion open
Specification of URIs in Uno udk/cpp/man/spec/uris.html Uno/Spec/Uniform Resource Identificator open
Binary Uno library versioning schema udk/common/man/libraryversioning.html Uno/Binary/Spec/Library Versioning open
C++ Uno runtime library API design udk/common/man/apicppclasses.html Uno/Cpp/Spec/API Design open
Binary Uno component naming schema udk/common/man/componentnames.html Uno/Binary/Spec/Component Naming open
Article about Uno lifecycle concepts udk/common/man/componentnames.html Uno/Article/The Object Lifecycle open
Article about the Uno execution model udk/common/man/execution.html Uno/Article/The Execution Model open
Binary Uno type system specification udk/common/man/typesystem.html Uno/Binary/Spec/Type System open
Binary Uno type names udk/common/man/typenames.html Uno/Binary/Spec/Type Names open
Uno Component specification udk/common/man/componentmodel.html Uno/Spec/Component open
Article about remotly bootstrapping Uno/OOo udk/common/man/spec/transparentofficecomponents.html Uno/Article/OOo-Uno Bootstrapping open
Article about the Java vendor framework udk/common/man/spec/javavendorextension.sxw Uno/Article/The Java Vendor Framework open
CLI Uno library versioning schema udk/common/man/spec/assemblyversioning.html Uno/CLI/Spec/Library Versioning open

Note: The http: links above are all relative to http://udk.openoffice.org .

Personal tools