jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k...@apache.org
Subject svn commit: r1871852 - in /jackrabbit/commons/filevault/trunk/vault-doc/src/site: markdown/config.md markdown/filter.md markdown/metadata.md markdown/nodetypes.md markdown/privileges.md markdown/settings.md site.xml
Date Fri, 20 Dec 2019 11:35:24 GMT
Author: kwin
Date: Fri Dec 20 11:35:24 2019
New Revision: 1871852

URL: http://svn.apache.org/viewvc?rev=1871852&view=rev
Log:
JCRVLT-384 document metadata of FileVault

Added:
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/config.md
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/metadata.md
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/nodetypes.md
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/privileges.md
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/settings.md
Modified:
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/filter.md
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/site.xml

Added: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/config.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/config.md?rev=1871852&view=auto
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/config.md (added)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/config.md Fri Dec 20 11:35:24
2019
@@ -0,0 +1,32 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+Config
+===========
+
+The FileVault Filesystem Configuration can be adjusted with a `META-INF/vault/config.xml`
file. 
+
+It allows to tweak aggregation settings of the [Vault FS](vaultfs.html). The default config
is at <https://github.com/apache/jackrabbit-filevault/blob/trunk/vault-core/src/main/resources/org/apache/jackrabbit/vault/fs/config/defaultConfig-1.1.xml>.
+
+To exclude binaries from exports/imports you can use the setting
+
+```xml
+    <properties>
+        <!-- configure binary-less serialization -->
+        <useBinaryReferences>true</useBinaryReferences>
+    </properties>
+```

Modified: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/filter.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/filter.md?rev=1871852&r1=1871851&r2=1871852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/filter.md (original)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/filter.md Fri Dec 20 11:35:24
2019
@@ -172,7 +172,6 @@ Content Package Serialized Content
     - property2="new"
 ```
 
-<!-- references -->
 [api.WorkspaceFilter]: apidocs/org/apache/jackrabbit/vault/fs/api/WorkspaceFilter.html
 [api.ImportMode]: apidocs/org/apache/jackrabbit/vault/fs/api/ImportMode.html
 [api.Pattern]: https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html
\ No newline at end of file

Added: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/metadata.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/metadata.md?rev=1871852&view=auto
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/metadata.md (added)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/metadata.md Fri Dec 20
11:35:24 2019
@@ -0,0 +1,31 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+Metadata
+===========
+
+Every repository export/package carries metadata (usually within the folder `META-INF/vault`).
+
+This is
+
+* [Filters (filter.xml)](filter.html), mandatory
+* [Package Properties (properties.xml)](properties.html), mandatory for packages
+* [Configuration (config.xml)](config.html), optional
+* [Settings (settings.xml)](settings.html), optional
+* [Nodetypes (*.cnd)](nodetypes.html), optional
+* [Privileges (privileges.xml)](privileges.html), optional
+* Package Definition (definition/.content.xml), TODO, optional
\ No newline at end of file

Added: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/nodetypes.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/nodetypes.md?rev=1871852&view=auto
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/nodetypes.md (added)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/nodetypes.md Fri Dec 20
11:35:24 2019
@@ -0,0 +1,21 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+Nodetypes
+===========
+
+Packages can register custom [JCR nodetypes](https://docs.adobe.com/docs/en/spec/jcr/2.0/8_Node_Type_Discovery.html)
during import by carrying arbitrarily many `.cnd` files. All files names matching the regular
expression pattern set in [package property](properties.html) `cndPattern` are considered.
Details around the CND file format can be found at <https://jackrabbit.apache.org/jcr/node-type-notation.html>.

Added: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/privileges.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/privileges.md?rev=1871852&view=auto
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/privileges.md (added)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/privileges.md Fri Dec 20
11:35:24 2019
@@ -0,0 +1,34 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+Privileges
+===========
+
+Packages can register custom [JCR privileges](https://docs.adobe.com/docs/en/spec/jcr/2.0/16_Access_Control_Management.html#16.2%20Privilege%20Discovery)
during import by carrying a `META-INF/vault/privileges.xml` file. 
+
+```xml
+<!DOCTYPE privileges [
+<!ELEMENT privileges (privilege)+>
+<!ELEMENT privilege (contains)+>
+<!ATTLIST privilege abstract (true|false) false>
+<!ATTLIST privilege name NMTOKEN #REQUIRED>
+<!ELEMENT contains EMPTY>
+<!ATTLIST contains name NMTOKEN #REQUIRED>
+]>
+```
+
+Aggregate privileges can be registered with the additional element `contains` which should
reference an existing privilege name.

Added: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/settings.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/settings.md?rev=1871852&view=auto
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/settings.md (added)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/settings.md Fri Dec 20
11:35:24 2019
@@ -0,0 +1,32 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+Settings
+===========
+
+The FileVault settings can be adjusted with a `META-INF/vault/settings.xml` file. 
+The settings allow to ignore certain certain file names during export operations.
+An example settings file looks like this:
+
+```xml
+<vault>
+  <ignore name=".DS_Store"/>
+  <ignore name=".svn"/>"
+</vault>
+```
+
+The `name` attribute is compared with the file name (not the full file path) and is not parsed
as regular expression!

Modified: jackrabbit/commons/filevault/trunk/vault-doc/src/site/site.xml
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/site.xml?rev=1871852&r1=1871851&r2=1871852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/site.xml (original)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/site.xml Fri Dec 20 11:35:24 2019
@@ -33,9 +33,16 @@
     </menu>
     <menu name="Using Filevault">
       <item href="usage.html" name="Getting Started" />
-      <item href="properties.html" name="Package Properties"/>
-      <item href="filter.html" name="Workspace Filter" />
-      <item href="importmode.html" name="Import Mode" />
+      <item href="metadata.html" name="Metadata" >
+        <item href="filter.html" name="Workspace Filter">
+            <item href="importmode.html" name="Import Mode" />
+        </item>
+        <item href="properties.html" name="Package Properties"/>
+        <item href="config.html" name="Vault FS Configuration"/>
+        <item href="settings.html" name="Settings"/>
+        <item href="nodetypes.html" name="Nodetypes"/>
+        <item href="privileges.html" name="Privileges"/>
+     </item>
       <item href="rcp.html" name="Vault Remote Copy" />
     </menu>
     <menu name="Developing">



Mime
View raw message