[ofbiz-framework] branch trunk updated: Documented: Content overview doc file migration in asciidoc format (OFBIZ-11384)
Locked
 
|
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git The following commit(s) were added to refs/heads/trunk by this push: new a881292 Documented: Content overview doc file migration in asciidoc format (OFBIZ-11384) a881292 is described below commit a88129294d9f196c59eb3892ea7fe134a239439a Author: holivier <[hidden email]> AuthorDate: Fri Feb 21 15:52:59 2020 +0100 Documented: Content overview doc file migration in asciidoc format (OFBIZ-11384) the new file content.adoc is call (via include) from user-manual.adoc content_IT is migrated too even if there is only 2 lines in it ! --- .../content/data/helpdata/HELP_CONTENT.xml | 164 ------------------- .../content/data/helpdata/HELP_CONTENT_IT.xml | 28 ---- .../data/helpdata/HELP_CONTENT_SITE_FindWeb.xml | 38 ----- .../content/src/docs/asciidoc/content.adoc | 179 +++++++++++++++++++++ .../content/src/docs/asciidoc/content_IT.adoc | 21 +++ docs/asciidoc/user-manual.adoc | 2 + 6 files changed, 202 insertions(+), 230 deletions(-) diff --git a/applications/content/data/helpdata/HELP_CONTENT.xml b/applications/content/data/helpdata/HELP_CONTENT.xml deleted file mode 100644 index 8abea72..0000000 --- a/applications/content/data/helpdata/HELP_CONTENT.xml +++ /dev/null @@ -1,164 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<!--from https://cwiki.apache.org/confluence/display/OFBENDUSER/Content+Management+Overview--> - -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Content Management Overview</title> - <para>The Document Content Management System (DMS/CMS) is designed to store data once and then allow it to be reused in multiple arrangements.</para> - - <section> - <title>Overview</title> - <para> - The term 'content management' generally refers to a system for acquiring, storing and retrieving electronic data in varying formats - such as text, images or proprietary formats. Content management systems (CMS) usually incorporate a rendering system to let the developer display the content in various formats. While some CMSs are rigid in the manner in which content is entered and rendered, the content management module of OFBiz is more of a set of tools which can be used in [...] - The OFBiz CMS is designed to store data once and then allow it to be reused in multiple arrangements. Hence, there are basically two aspects - the back-end storage subsystem, which is oriented around the DataResource entity, and the front-end association subsystem, which revolves around the Content entity. Note that the Content entity has a foreign key pointing to one and only one DataResource entity, but the same DataResource entity can be referenced by multiple Content enti [...] - Content entities are related to other content via ContentAssoc entities. The ContentAssoc entity has a four part primary key and other fields that are used to relate content. The key specifies the 'to' Content and the 'from' Content, as well as the type of association and its effective date. See the discussion of the ContentAssoc entity for more information on how content is related. - </para> - </section> - <section> - <title>Major CMS entities</title> - <section> - <title>DataResource</title> - <para> - The DataResource entity acts as the gateway to actual content retrieval. There are two important fields for determining the format and storage of a resource. These are the 'mimeTypeId' and the 'dataResourceTypeId'. - </para> - </section> - <section> - <title>mimeTypeId</title> - <para> - The mime type is the standard Multipurpose Internet Mail Extension, of which, 'text/html' and 'image/gif' will be two of the more common examples. The mimeTypeId indicates the format of the content as it is stored. This must be compared to the desired output format to see if the rendering system can handle the request. For example, if the DataResource.mimeTypeId equals, 'image/png', and the target output format is 'text/html', the rendering system could make the logical s [...] - </para> - </section> - <section> - <title>dataResourceTypeId</title> - <para> - The dataResourceTypeId field indicates the storage mechanism for the resource. It could be of type ELECTRONIC_TEXT, which indicates that there is an entry in the ElectronicText table that is related to the DataResource by its primary key. - If the mimeTypeId is of type image, then the dataResourceId could be IMAGE_OBJECT (stored in the database ImageDataResource table), OFBIZ_FILE (stored in a file the path of which is relative to the OFBiz home directory) or URL_RESOURCE (could be accessed via HTTP protocol). - </para> - </section> - <section> - <title>dataTemplateTypeId</title> - <para> - One of the powerful concepts of the OFBiz CMS is that it can store templates that can be used to control the formatting of data. In this case, the resource pointed to by the DataResource entity will not be rendered, itself; instead, it will be used as a template to format data that is associated with it. The currently supported templating types are FreeMarker (FTL) and the OFBiz Screen Widget (SCREEN_COMBINED) format. - If the value of dataTemplateTypeId is empty or equal to NONE, then the data pointed to by the dataResource entity is rendered directly. - </para> - </section> - <section> - <title>objectInfo</title> - <para> - If dataResourceTypeId is ELECTRONIC_TEXT or IMAGE_OBJECT, then objectInfo is not used, but for other types, it will contain the resource storage information. If dataResourceTypeId is one of OFBIZ_FILE, CONTEXT_FILE, LOCAL_FILE or URL_RESOURCE; then objectInfo contains path info. If dataResourceTypeId equals SHORT_TEXT, then objectInfo will contain the actual resource (short text) value. - </para> - </section> - </section> - <section> - <title>ElectronicText</title> - <para> - ElectronicText contains ASCII text data. An ElectronicText entity can be associated with only one DataResource entity and vice-versa. The mimeTypeId field of the DataResource entity must be checked to determine the format of the ElectronicText data. - </para> - </section> - <section> - <title>ImageDataResource</title> - <para> - ImageDataResource is the equivalent of ElectronicText for binary image data. The DataResource.mimeTypeId must be checked to determine the format of the data. - </para> - </section> - <section> - <title>Content</title> - <para> - The Content entity determines how DataResources are rendered. It does this on a 'local' level, in that it has a mimeTypeId, localeString and other fields that indicate to the rendering system how the DataResource should look, but it can also control the larger picture because it can act as a placeholder and head for other content. The Content.dataResourceId does not need to point to anything, instead a Content entity can be related to other Content via ContentAssoc entities. [...] - </para> - <section> - <title>dataResourceId</title> - <para> - The dataResourceId points to a DataResource entity that represents content associated with the parent Content entity. The related DataResource could be data that is rendered or it could be a template that indicates how child Content of the parent Content are rendered. - </para> - </section> - <section> - <title>contentName</title> - <para> - contentName is the field that is used to represent the Content entity in lists. The contentName field value must be less than 100 characters. - </para> - </section> - <section> - <title>description</title> - <para> - description is used in cases where a short summary or description of the Content is desired. The description field value must be less than 255 characters. - </para> - </section> - <section> - <title>templateDateResourceId</title> - <para> - The templateDataResourceId field points to a DataResource entity that is used to transform the data contained in the DataResource pointed to by the Content.dataResourceId field. The dataTemplateTypeId of the DataResource pointed to by templateDataResourceId will be checked to determine what sort of transform will be applied. - </para> - </section> - </section> - <section> - <title>ContentRole</title> - <para> - The ContentRole entity is used to assign permission authority to a piece of content. The ContentRole entity identifies the Content to which the authority is being attached and the Party that has that authority and what sort of authority (role) that party has. The ContentRole also establishes the time frame (from/thruDate) for which that authority is valid. - </para> - </section> - <section> - <title>ContentPurpose</title> - <para> - The ContentPurpose entity adds extra information to a Content entity that is used to determine what permissions are required to access that Content. - </para> - </section> - <section> - <title>ContentPurposeOperation</title> - <para> - ContentPurposeOperation is used to setup permission validation rules. - </para> - </section> - <section> - <title>ContentAssoc</title> - <para> - ContentAssoc relates one Content entity to another. A sense of direction is conveyed in the fact that one field is named contentIdTo (the from field is contentId). - </para> - <section> - <title>contentId</title> - <para> - This is the 'parent' Content in a Content-to-Content relationship. - </para> - </section> - <section> - <title>contentIdTo</title> - <para> - This field is the 'from' or 'child' field in a Content-to-Content relationship. - </para> - </section> - <section> - <title>contentAssocTypeId</title> - <para> - The contentAssocTypeId field is used to add information about the type of a Content-to-Content relationship. It is part of the primary key. Two Content entities can be related by multiple ContentAssoc entities if the contentAssocTypeId field varies (or the fromDate is different). - </para> - </section> - <section> - <title>fromDate</title> - <para> - the fromDate field is part of the primary key. - </para> - </section> - </section> -</section> - diff --git a/applications/content/data/helpdata/HELP_CONTENT_IT.xml b/applications/content/data/helpdata/HELP_CONTENT_IT.xml deleted file mode 100644 index ddf2837..0000000 --- a/applications/content/data/helpdata/HELP_CONTENT_IT.xml +++ /dev/null @@ -1,28 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Panoramica sul gestore di contenuti</title> - <para>Il gestore di contenuti e documenti (CMS/DMS) e' utilizzato per archiviare i dati e per richiamarli in contesti multipli.</para> -</section> - diff --git a/applications/content/data/helpdata/HELP_CONTENT_SITE_FindWeb.xml b/applications/content/data/helpdata/HELP_CONTENT_SITE_FindWeb.xml deleted file mode 100644 index 9b04bce..0000000 --- a/applications/content/data/helpdata/HELP_CONTENT_SITE_FindWeb.xml +++ /dev/null @@ -1,38 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>The Main Content help screen</title> - <para>Introductory text for the content component</para> - <section> - <title>subsection heading</title> - <para>Subsection content</para> - </section> - <section> - <title>Subsection 2 title</title> - <para> - for more info see the <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Home">OFBiz documentation site</link> for more info. - </para> - </section> -</section> - diff --git a/applications/content/src/docs/asciidoc/content.adoc b/applications/content/src/docs/asciidoc/content.adoc new file mode 100644 index 0000000..e5fa40c --- /dev/null +++ b/applications/content/src/docs/asciidoc/content.adoc @@ -0,0 +1,179 @@ +//// +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. +//// += Content Management Overview +The Document Content Management System (DMS/CMS) is designed to store data once and then allow it to be reused + in multiple arrangements. + +== Overview +The term 'content management' generally refers to a system for acquiring, storing and retrieving electronic data + in varying formats - such as text, images or proprietary formats. + +Content management systems (CMS) usually incorporate a rendering system to let the developer display the content + in various formats. + +While some CMSs are rigid in the manner in which content is entered and rendered, the content management module of OFBiz + is more of a set of tools which can be used in a variety of situations. + +In addition to HTML, the content can be rendered in non-Web modes, such as PDF or email newsletters. + +The OFBiz CMS is designed to store data once and then allow it to be reused in multiple arrangements. + +Hence, there are basically two aspects + +* the back-end storage subsystem, which is oriented around the DataResource entity, +* and the front-end association subsystem, which revolves around the Content entity. + +Note that the Content entity has a foreign key pointing to one and only one DataResource entity, +but the same DataResource entity can be referenced by multiple Content entities. + +It is a general rule that data can only be accessed via a Content entity, +but one common exception is that images are typically served up using the DataResource primary key. + +Content entities are related to other content via ContentAssoc entities. +The ContentAssoc entity has a four part primary key and other fields that are used to relate content. +The key specifies the 'to' Content and the 'from' Content, as well as the type of association and its effective date. +See the discussion of the ContentAssoc entity for more information on how content is related. + +== Major CMS entities + +=== DataResource +The DataResource entity acts as the gateway to actual content retrieval. + +There are two important fields for determining the format and storage of a resource : + +* the 'mimeTypeId' +* the 'dataResourceTypeId'. + +==== mimeTypeId +The mime type is the standard Multipurpose Internet Mail Extension, of which, 'text/html' and 'image/gif' will be + two of the more common examples. + +The mimeTypeId indicates the format of the content as it is stored. + +This must be compared to the desired output format to see if the rendering system can handle the request. + +For example, if the DataResource.mimeTypeId equals, 'image/png', and the target output format is 'text/html', +the rendering system could make the logical supposition that it should return an HTML "img.../" tag. +If the output format were 'application/pdf' then it will need to determine if it can convert the image to a PDF format. + +==== dataResourceTypeId +The dataResourceTypeId field indicates the storage mechanism for the resource. + +It could be of type ELECTRONIC_TEXT, which indicates that there is an entry in the ElectronicText table that is related + to the DataResource by its primary key. + +If the mimeTypeId is of type image, then the dataResourceId could be IMAGE_OBJECT (stored in the database ImageDataResource table), + OFBIZ_FILE (stored in a file the path of which is relative to the OFBiz home directory) or + URL_RESOURCE (could be accessed via HTTP protocol). + + +=== dataTemplateTypeId +One of the powerful concepts of the OFBiz CMS is that it can store templates that can be used to control the formatting of data. + +In this case, the resource pointed to by the DataResource entity will not be rendered, itself; +instead, it will be used as a template to format data that is associated with it. + +The currently supported templating types are FreeMarker (FTL) and the OFBiz Screen Widget (SCREEN_COMBINED) format. +If the value of dataTemplateTypeId is empty or equal to NONE, +then the data pointed to by the dataResource entity is rendered directly. + +=== objectInfo +If dataResourceTypeId is ELECTRONIC_TEXT or IMAGE_OBJECT, then objectInfo is not used, + but for other types, it will contain the resource storage information. + +If dataResourceTypeId is one of OFBIZ_FILE, CONTEXT_FILE, LOCAL_FILE or URL_RESOURCE; then objectInfo contains path info. + +If dataResourceTypeId equals SHORT_TEXT, then objectInfo will contain the actual resource (short text) value. + +==== ElectronicText +ElectronicText contains ASCII text data. + +An ElectronicText entity can be associated with only one DataResource entity and vice-versa. + +The mimeTypeId field of the DataResource entity must be checked to determine the format of the ElectronicText data. + +==== ImageDataResource +ImageDataResource is the equivalent of ElectronicText for binary image data. + +The DataResource.mimeTypeId must be checked to determine the format of the data. + +== Content +The Content entity determines how DataResources are rendered. + +It does this on a 'local' level, in that it has a mimeTypeId, localeString and other fields that indicate + to the rendering system how the DataResource should look, but it can also control the larger picture because + it can act as a placeholder and head for other content. + +The Content.dataResourceId does not need to point to anything, instead a Content entity can be related to + other Content via ContentAssoc entities. + +At some point, some of the child Content entities must point to DataResources, else nothing will ever be displayed. + +=== dataResourceId +The dataResourceId points to a DataResource entity that represents content associated with the parent Content entity. + +The related DataResource could be data that is rendered or it could be a template that indicates how child Content + of the parent Content are rendered. + +=== contentName +contentName is the field that is used to represent the Content entity in lists. +The contentName field value must be less than 100 characters. + +=== description +description is used in cases where a short summary or description of the Content is desired. +The description field value must be less than 255 characters. + +=== templateDateResourceId +The templateDataResourceId field points to a DataResource entity that is used to transform + the data contained in the DataResource pointed to by the Content.dataResourceId field. + +The dataTemplateTypeId of the DataResource pointed to by templateDataResourceId will be checked + to determine what sort of transform will be applied. + + +== ContentRole +The ContentRole entity is used to assign permission authority to a piece of content. + +The ContentRole entity identifies the Content to which the authority is being attached and + the Party that has that authority and what sort of authority (role) that party has. + +The ContentRole also establishes the time frame (from/thruDate) for which that authority is valid. + +== ContentPurpose +The ContentPurpose entity adds extra information to a Content entity that is used to determine what permissions + are required to access that Content. + +== ContentPurposeOperation +ContentPurposeOperation is used to setup permission validation rules. + +== ContentAssoc +ContentAssoc relates one Content entity to another. + +A sense of direction is conveyed in the fact that one field is named contentIdTo (the from field is contentId). + +=== contentId +This is the 'parent' Content in a Content-to-Content relationship. + +=== contentIdTo +This field is the 'from' or 'child' field in a Content-to-Content relationship. + +=== contentAssocTypeId +The contentAssocTypeId field is used to add information about the type of a Content-to-Content relationship. +It is part of the primary key. + +Two Content entities can be related by multiple ContentAssoc entities if the contentAssocTypeId field varies + (or the fromDate is different). + +=== fromDate +the fromDate field is part of the primary key. diff --git a/applications/content/src/docs/asciidoc/content_IT.adoc b/applications/content/src/docs/asciidoc/content_IT.adoc new file mode 100644 index 0000000..106ba11 --- /dev/null +++ b/applications/content/src/docs/asciidoc/content_IT.adoc @@ -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. +//// += Panoramica sul gestore di contenuti + +Il gestore di contenuti e documenti (CMS/DMS) e' utilizzato per archiviare i dati e per richiamarli in contesti multipli. \ No newline at end of file diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index 83df2c2..ad0a7e1 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -155,4 +155,6 @@ of how to achieve common tasks. include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+2] +include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+2] + include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+2] |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |