Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DDL for 7.1 docs #17

Merged

Conversation

@rbohl
Copy link

rbohl commented Jul 16, 2018

@natocesarrego

This comment has been minimized.

Copy link
Owner

natocesarrego commented Jul 30, 2018

Just started reviewing :)

:octocat: Sent from GH.

@liferay-continuous-integration-hu liferay-continuous-integration-hu merged commit f803660 into natocesarrego:master Aug 1, 2018
Copy link
Owner

natocesarrego left a comment

Hey @rbohl,

Finally, I was able to finish the review of this pull request. 🎉

Sorry for the delay, but a lot of tasks with high priority were assigned to me in the last weeks.

Please see my comments regarding this pull and if you need any clarification, just let me know, ok?

Thanks for your patience.


The Dynamic Data Lists Service entry contains one setting:

**Add Default Structures:**

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Duplicated colon in every section of the System Configuration.

**Add Default Structures:**
: This is enabled by default, and pre-loads several embedded data definitions to
base data lists on. Once loaded on portal startup, these definitions must be
manually deleted from the site menu. Dynamic Data Lists application. This

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Unnecessary dot before Dynamic Data Lists.

designer, which is below the form's Details section. The designer's *View*
tab, which is selected by default, lets you create the definition in a
WYSIWYG editor. You can click the *Source* tab to work with the definition's
underlying XML, but we recommend sticking with the WYSIWYG editor.

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Currently, the definition is built using JSON and not XML.

`double`.
- **Documents and Media:** Select a file from a Documents and Media
library.
- **Geolocation:** Specify a location to associate with the document.

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Actually, the Geolocation field is used to associate a location with the data being inputted by the user, instead of associate a location with a specific document uploaded through the Documents and Media field. I think it's important to highlight this in order to avoid misunderstanding from the reader's side.

- **Documents and Media:** Select a file from a Documents and Media
library.
- **Geolocation:** Specify a location to associate with the document.
- **HTML:** An area that uses a WYSIWYG editor to enhance the content.

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Is there any chance to increase the details in the description of this field? Honestly, after read it, I had the feeling I didn't get the real idea of this field. Currently, isn't clear that the user can input HTML content to be displayed.

This comment has been minimized.

Copy link
@rbohl

rbohl Aug 9, 2018

Author

@natocesarrego
How about

An area that uses a WYSIWYG editor to write and display HTML content.

This comment has been minimized.

Copy link
@natocesarrego
table lists any existing data definitions.

3. Click the definition's *Actions* button
(![Options](../../../images/icon-options.png))

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Shouldn't be the ../../../images/icon-actions.png instead?

[Creating Data Lists article](liferay.com)
for adding and configuring the widget in a site page. Make sure to configure
the widget to show the list whose definition you want to create a template
for.

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

On the most recent version of this article, the word whose was removed, but its absence changes the meaning of the sentence and, in my opinion, it shouldn't be removed.

This comment has been minimized.

Copy link
@rbohl

rbohl Aug 9, 2018

Author

Good point. I think we can phrase this to be in terms of the list since that's the way the user will be thinking. They're creating a template with a certain list in mind, right?

Make sure to configure the widget to show the list you're creating a template for.

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 10, 2018

Owner

Correct! I see what you mean. Sounds good.

<#-- The below gets the Company field and wraps it in an <em> tag -->
Company Name: <em>${ddlDisplayTemplateHelper.renderRecordFieldValue(cur_record.getDDMFormFieldValues("company")?first, locale)}</em><br />
<#-- The below gets the Email field and wraps it in an <em> tag -->
Email: ${ddlDisplayTemplateHelper.renderRecordFieldValue(cur_record.getDDMFormFieldValues("email")?first, locale)}

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

The Email: isn't displayed in the screenshot. 😞

This comment has been minimized.

Copy link
@rbohl

rbohl Aug 9, 2018

Author

It looks like this is already fixed in master

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 10, 2018

Owner

I believe I've reviewed using the master branch and it seems to be the same way. 😞

This comment has been minimized.

Copy link
@rbohl

rbohl Aug 10, 2018

Author

Yes, you're right! Sorry for my confusion. Fixed here: rbohl@82b8888


Helper variables are available in the template editor. These provide access to
most of the data that you'll use in creating Display Templates. The variables
under the heading Data List Variables let you inject specific information about

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

The variables under the Data List Variables section available on the UI are mentioned, but the following image displays theirs names as they're shown in the Script field, which are different from the names shown on the UI, hence I believe that it can confuse a little a reader that isn't very familiar with the DDL Display Template.

Does it make sense to you?

This comment has been minimized.

Copy link
@rbohl

rbohl Aug 9, 2018

Author

It makes sense. I think any confusion will be cleared up quickly once they hover over the variables or click them to add the script, but it might make sense to display the list like this instead:

Data Definition ID: reserved_ddm_structure_id

Data List Description: reserved_record_set_description

Data List ID: reserved_record_set_id

Data List Name: reserved_record_set_name

Template ID: reserved_ddm_template_id

What do you think?

This comment has been minimized.

Copy link
@natocesarrego
reserved_ddm_template_id

Inside a template, these variables give the ID for the record set (that contains
all of the volunteers in our list), as well as the name, description and data

This comment has been minimized.

Copy link
@natocesarrego

natocesarrego Aug 8, 2018

Owner

Who are these volunteers? I didn't see any information in regards to this context, maybe it's my fault. 😁

This comment has been minimized.

Copy link
@rbohl

rbohl Aug 9, 2018

Author

I believe that's leftover from our 7.0 example. I'll cut it out. 😃

@rbohl

This comment has been minimized.

Copy link
Author

rbohl commented Aug 9, 2018

@natocesarrego My review edits are here: rbohl@98e91df

@natocesarrego

This comment has been minimized.

Copy link
Owner

natocesarrego commented Aug 10, 2018

Awesome, @rbohl! Green light for me. 👏 👏

@rbohl

This comment has been minimized.

Copy link
Author

rbohl commented Aug 10, 2018

Sent for publication here: sez11a#3459

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.