chemistry-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From f...@apache.org
Subject svn commit: r1751938 - in /chemistry/docs/cmis-samples/trunk: ./ docs/ docs/css/ docs/samples/
Date Fri, 08 Jul 2016 16:12:02 GMT
Author: fmui
Date: Fri Jul  8 16:12:02 2016
New Revision: 1751938

URL: http://svn.apache.org/viewvc?rev=1751938&view=rev
Log:
documentation corrections

Added:
    chemistry/docs/cmis-samples/trunk/docs/samples/retention.md
Modified:
    chemistry/docs/cmis-samples/trunk/docs/about.md
    chemistry/docs/cmis-samples/trunk/docs/css/chemistry.css
    chemistry/docs/cmis-samples/trunk/docs/index.md
    chemistry/docs/cmis-samples/trunk/docs/samples/allowable-actions.md
    chemistry/docs/cmis-samples/trunk/docs/samples/content.md
    chemistry/docs/cmis-samples/trunk/docs/samples/lists.md
    chemistry/docs/cmis-samples/trunk/docs/samples/operation-context.md
    chemistry/docs/cmis-samples/trunk/docs/samples/queries.md
    chemistry/docs/cmis-samples/trunk/docs/samples/retrieve-objects.md
    chemistry/docs/cmis-samples/trunk/mkdocs.yml

Modified: chemistry/docs/cmis-samples/trunk/docs/about.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/about.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/about.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/about.md Fri Jul  8 16:12:02 2016
@@ -9,9 +9,9 @@ If you have any questions, subscribe to
 
 License: [Apache 2.0](https://www.apache.org/licenses/)
 
-[Apache Chemistry](https://chemistry.apache.org/), [Apache](https://chemistry.apache.org/),
the Apache feather logo, and the Apache Chemistry project logo are trademarks of [The Apache
Software Foundation](https://www.apache.org/).  
-Content Management Interoperability Services (CMIS) is an [OASIS](http://www.oasis-open.org/committees/cmis/)
specification.
+[Apache Chemistry](https://chemistry.apache.org/), [Apache](https://www.apache.org/){:target="_blank"},
the Apache feather logo, and the Apache Chemistry project logo are trademarks of [The Apache
Software Foundation](https://www.apache.org/){:target="_blank"}.  
+Content Management Interoperability Services (CMIS) is an [OASIS](http://www.oasis-open.org/committees/cmis/){:target="_blank"}
specification.
 
 ---
 
-Documentation built with [MkDocs](http://www.mkdocs.org/) using the modified [Cinder](https://sourcefoundry.org/cinder/)
theme. 
\ No newline at end of file
+Documentation built with [MkDocs](http://www.mkdocs.org/){:target="_blank"} using the modified
[Cinder](https://sourcefoundry.org/cinder/){:target="_blank"} theme. 
\ No newline at end of file

Modified: chemistry/docs/cmis-samples/trunk/docs/css/chemistry.css
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/css/chemistry.css?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/css/chemistry.css (original)
+++ chemistry/docs/cmis-samples/trunk/docs/css/chemistry.css Fri Jul  8 16:12:02 2016
@@ -83,6 +83,10 @@ div[class~="note"] p[class~="admonition-
 <i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
 }
 
+div[class~="note"] code {
+    background-color: transparent;
+}
+
 .warning {
     color: white;
     background-color: #f04124;
@@ -100,4 +104,8 @@ div[class~="warning"] p[class~="admoniti
     -webkit-font-smoothing: antialiased;
     -moz-osx-font-smoothing: grayscale;
     content: "\f071\00a0";
+}
+
+div[class~="warning"] code {
+    background-color: transparent;
 }
\ No newline at end of file

Modified: chemistry/docs/cmis-samples/trunk/docs/index.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/index.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/index.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/index.md Fri Jul  8 16:12:02 2016
@@ -4,7 +4,7 @@
 
 ![CMIS](img/cmis.png){: style="float:left; margin-right: 20px;"}
 
-[CMIS (Content Management Interoperability Services)][cmis] is an OASIS standard enabling
information sharing between different Content Management Systems.
+[CMIS (Content Management Interoperability Services)][cmis]{:target="_blank"} is an OASIS
standard enabling information sharing between different Content Management Systems.
 
 <div style="clear:both"></div>
 ---
@@ -14,8 +14,13 @@ This is a collection of code samples for
 ![Apache Chemistry](img/chemistry-logo.png){: style="float:left; margin-right: 20px;"}
 
 - [Apache Chemistry OpenCMIS][opencmis] - a CMIS library for Java
-- [Apache Chemistry PortCMIS][portcmis] - a CMIS library for.Net
+- [Apache Chemistry PortCMIS][portcmis] - a CMIS library for .Net
 
+We assume that you have a rough understanding of CMIS. This is not a CMIS introduction course.
+
+Many code samples are marked with <span class="cmis">CMIS 1.0</span> or <span
class="cmis">CMIS 1.1</span>. Those tags indicate the CMIS specification version
that the server has to support to use the feature.
+
+Throughout the code samples you will find references to sections in the [CMIS 1.1 specification][cmis11spec]{:target="_blank"};
tags like <span class="spec">Spec 1.5</span>. We recommend that you have the specification
document ready to hand. 
 
 !!! note "Under Development"
     This sample collection is under development. Some areas are only sparely covered or not
covered at all, yet.
@@ -25,7 +30,7 @@ This is a collection of code samples for
 
 ## Apache Chemistry&trade;
 
-[Apache Chemistry][chemistry] provides open source client and server implementations of [CMIS
1.0][cmis10] and [CMIS 1.1][cmis11] for multiple programming languages (Java, .Net, Python,
PHP, Objective-C, JavaScript, ...).  
+[Apache Chemistry][chemistry] provides open source client and server implementations of [CMIS
1.0][cmis10]{:target="_blank"} and [CMIS 1.1][cmis11]{:target="_blank"} for multiple programming
languages (Java, .Net, Python, PHP, Objective-C, JavaScript, ...).  
 
 ---
 
@@ -33,7 +38,7 @@ This is a collection of code samples for
 
 ![CMIS and Apache Chemistry in Action](img/apache-chemistry-in-action.png){: style="float:left;
margin-right: 20px;"}
 
-The book [CMIS and Apache Chemistry in Action](https://www.manning.com/mueller/) is a comprehensive
guide to the CMIS standard and related ECM concepts. In it, you'll tackle hands-on examples
for building applications on CMIS repositories from both the client and the server sides.
You'll find working examples using the Apache Chemistry APIs for Java, Python, C#, Objective-C,
and PHP, but you can use the techniques you'll learn in this book to work with CMIS repositories
using any language that can speak HTTP - including JavaScript.
+The book [CMIS and Apache Chemistry in Action](https://www.manning.com/books/cmis-and-apache-chemistry-in-action){:target="_blank"}
is a comprehensive guide to the CMIS standard and related ECM concepts. In it, you'll tackle
hands-on examples for building applications on CMIS repositories from both the client and
the server sides. You'll find working examples using the Apache Chemistry APIs for Java, Python,
C#, Objective-C, and PHP, but you can use the techniques you'll learn in this book to work
with CMIS repositories using any language that can speak HTTP - including JavaScript.
 
 <div style="clear:both"></div>
 ---
@@ -88,7 +93,7 @@ compile group: 'org.apache.chemistry.ope
 
 [PortCMIS][portcmis] is a CMIS client library for .Net. It is a Portable Class Library that
runs on servers, desktops, and Windows Mobile.
 
-To get started with PortCMIS, download the [PortCMIS client binaries](https://chemistry.apache.org/dotnet/portcmis.html).
You have the choice of either plain DLLs or NUPGK packages. It is also availabe on [nuget](https://www.nuget.org/packages/PortCMIS/):
+To get started with PortCMIS, download the [PortCMIS client binaries](https://chemistry.apache.org/dotnet/portcmis.html).
You have the choice of either plain DLLs or NUPGK packages. It is also availabe on [nuget](https://www.nuget.org/packages/PortCMIS/){:target="_blank"}:
 
 ```
 PM> Install-Package PortCMIS 
@@ -111,4 +116,6 @@ For new projects it is recommend to use
 [dotcmis]: https://chemistry.apache.org/dotnet/dotcmis.html
 [cmis]: https://www.oasis-open.org/committees/cmis
 [cmis10]: https://docs.oasis-open.org/cmis/CMIS/v1.0/
-[cmis11]: https://docs.oasis-open.org/cmis/CMIS/v1.1/
\ No newline at end of file
+[cmis11]: https://docs.oasis-open.org/cmis/CMIS/v1.1/
+[cmis10spec]: https://docs.oasis-open.org/cmis/CMIS/v1.0/cmis-spec-v1.0.pdf
+[cmis11spec]:https://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.pdf
\ No newline at end of file

Modified: chemistry/docs/cmis-samples/trunk/docs/samples/allowable-actions.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/allowable-actions.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/allowable-actions.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/allowable-actions.md Fri Jul  8 16:12:02
2016
@@ -3,6 +3,12 @@
 <span class="cmis">CMIS 1.0</span>
 <span class="cmis">CMIS 1.1</span>
 
+Allowable Actions let clients check if the current user is allowed to perform an action.
Clients can and should use this, for example, to disable or remove buttons, menu items, or
links that wouldn't work for the current user.
+
+!!! note 
+    Calculating the Allowable Actions can be an expensive operation for some CMIS repositories.
The performance can suffer noticeably if many objects have to be returned, for example by
`getChildren()`. Only request the Allowable Actions if you really need them. Use an [Operation
Context](operation-context/index.html#allowable-actions) to turn Allowable Actions on or off.
+
+
 OpenCMIS (Java)
 {: .opencmis }
 ```java

Modified: chemistry/docs/cmis-samples/trunk/docs/samples/content.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/content.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/content.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/content.md Fri Jul  8 16:12:02 2016
@@ -69,7 +69,12 @@ string mimeType = MimeMapping.GetMimeMap
 <span class="cmis">CMIS 1.0</span>
 <span class="cmis">CMIS 1.1</span>
 
-The code snippets below show how to get the content of document. If a document has no content,
`getContentStream()` returns `null`.
+The code snippets below show how to get the content of document.
+
+!!! note
+    CMIS differentiates between documents with no content and documents with a content of
0 bytes.  
+    If a document has no content, `getContentStream()` returns `null`. If a document has
a 0 byte content, `getContentStream()` returns a content stream object with an empty stream.
+
 
 OpenCMIS (Java)
 {: .opencmis }
@@ -228,7 +233,7 @@ CMIS only supports server managed rendit
 ### Getting the List of Renditions
 
 !!! note 
-    The list of renditions is only available if it has been requested with an [Operation
Context](operation-context/index.html).
+    The list of renditions is only available if it has been requested with an [Operation
Context](operation-context/index.html#rendition-filter).
 
 OpenCMIS (Java)
 {: .opencmis }

Modified: chemistry/docs/cmis-samples/trunk/docs/samples/lists.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/lists.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/lists.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/lists.md Fri Jul  8 16:12:02 2016
@@ -36,7 +36,7 @@ ItemIterable<Something> firstFive = some
 ItemIterable<Something> skipTen = somethingList.skipTo(10);
 
 // get a page of 20 items starting at the 100th item of the orignal list
-ItemIterable<Something> skipTen = somethingList.skipTo(100).getPage(20);
+ItemIterable<Something> skipAndPage = somethingList.skipTo(100).getPage(20);
 ```
 
 PortCMIS (C#)
@@ -51,5 +51,5 @@ IItemEnumerable<Something> firstFive = s
 IItemEnumerable<Something> skipTen = somethingList.SkipTo(10);
 
 // get a page of 20 items starting at the 100th item of the orignal list
-IItemEnumerable<Something> skipTen = somethingList.SkipTo(100).GetPage(20);
+IItemEnumerable<Something> skipAndPage = somethingList.SkipTo(100).GetPage(20);
 ```

Modified: chemistry/docs/cmis-samples/trunk/docs/samples/operation-context.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/operation-context.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/operation-context.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/operation-context.md Fri Jul  8 16:12:02
2016
@@ -209,3 +209,32 @@ IOperationContext oc2 = OperationContext
 // create an operation context that selects everything
 IOperationContext oc3 = OperationContextUtils.CreateMaximumOperationContext();
 ```
+
+
+## Using an Operation Context
+
+Many methods that retrieve objects or data accept an Operation Context object as an additional
parameter.
+If no Operation Context object is provided, a default Operation Context object defines what
should be requested.
+
+
+OpenCMIS (Java)
+{: .opencmis }
+```java
+OperationContext oc = ...
+
+CmisObject cmisObject1 = session.getObject(id, oc);
+CmisObject cmisObject2 = session.getObjectByPath(path, oc);
+ItemIterable<CmisObject> children = folder.getChildren(oc);
+List<Document> versions = doc.getAllVersions(oc);
+```
+
+PortCMIS (C#)
+{: .portcmis }
+```csharp
+IOperationContext oc = ...
+
+ICmisObject cmisObject1 = session.GetObject(id, oc);
+ICmisObject cmisObject2 = session.GetObjectByPath(path, oc);
+IItemEnumerable<ICmisObject> children = folder.GetChildren(oc);
+IList<IDocument> versions = doc.GetAllVersions(oc);
+```

Modified: chemistry/docs/cmis-samples/trunk/docs/samples/queries.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/queries.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/queries.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/queries.md Fri Jul  8 16:12:02 2016
@@ -63,7 +63,9 @@ qs.setId(6, folder);
 qs.setProperty(7, "cmis:document", "cmis:createdBy");
 qs.setString(8, "bob", "tom", "lisa"); 
 
+// get the compiled query statement
 String statement = qs.toQueryString();
 
-ItemIterable<QueryResult> results = statement.query(false);
+// ... or execute the query directly
+ItemIterable<QueryResult> results = qs.query(false);
 ```
\ No newline at end of file

Added: chemistry/docs/cmis-samples/trunk/docs/samples/retention.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/retention.md?rev=1751938&view=auto
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/retention.md (added)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/retention.md Fri Jul  8 16:12:02 2016
@@ -0,0 +1,13 @@
+# Retention and Holds
+
+<span class="cmis">CMIS 1.1</span>
+<span class="spec">Spec 2.1.16</span>
+
+## Retention
+
+<span class="spec">Spec 2.1.16.1</span>
+<span class="spec">Spec 2.1.16.2</span>
+
+## Holds
+
+<span class="spec">Spec 2.1.16.3</span>
\ No newline at end of file

Modified: chemistry/docs/cmis-samples/trunk/docs/samples/retrieve-objects.md
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/docs/samples/retrieve-objects.md?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/docs/samples/retrieve-objects.md (original)
+++ chemistry/docs/cmis-samples/trunk/docs/samples/retrieve-objects.md Fri Jul  8 16:12:02
2016
@@ -186,7 +186,7 @@ CmisObject cmisObject = session.getObjec
 PortCMIS (C#)
 {: .portcmis }
 ```csharp
-IOperationContext oc = session.CreateOperationContext();
+IOperationContext oc = Session.CreateOperationContext();
 oc.CacheEnabled = false;
 
 ICmisObject cmisObject = Session.GetObject(id, oc);

Modified: chemistry/docs/cmis-samples/trunk/mkdocs.yml
URL: http://svn.apache.org/viewvc/chemistry/docs/cmis-samples/trunk/mkdocs.yml?rev=1751938&r1=1751937&r2=1751938&view=diff
==============================================================================
--- chemistry/docs/cmis-samples/trunk/mkdocs.yml (original)
+++ chemistry/docs/cmis-samples/trunk/mkdocs.yml Fri Jul  8 16:12:02 2016
@@ -36,4 +36,5 @@ pages:
     - Access Control:
         - 'Checking Allowable Actions': 'samples/allowable-actions.md'
         - 'Managing Access Control': 'samples/access-control.md'
+        - 'Retention and Holds': 'samples/retention.md'
     - About: 'about.md'
\ No newline at end of file



Mime
View raw message