Skip to content

Commit be2543c

Browse files
Revert "updated best practices header and changed portal references to DX"
This reverts commit 35cfb96e945707f93f9030fee0f395e604927021.
2 parents a2813a5 + 844ed8b commit be2543c

File tree

62 files changed

+1108
-638
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1108
-638
lines changed

docs/.pages

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ nav:
77
- manage_content
88
- extend_dx
99
- guide_me
10-
- early_access
10+
- early_access
11+
- DX Compose: https://help.hcl-software.com/digital-experience/dx-compose/latest/
-3.29 KB
Loading
-2.89 KB
Loading
411 KB
Loading
406 KB
Loading
Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
# Configuring Web Content Manager search options
22

3-
You can edit the following search options to manage how the search service works with Web Content Manager search forms.
3+
Configure the **WCM SearchService** search properties from the WebSphere Integrated Solutions Console to manage how the search service works with Web Content Manager search forms.
44

5-
You can edit the following search options to manage how the search service works with Web Content Manager search forms
6-
7-
1. Open WebSphere Integrated Solutions Console to configure the **WCM SearchService** properties. Go to **Resources** \> **Resource Environment** \> **Resource Environment Providers**.
5+
1. Go to **Resources** \> **Resource Environment** \> **Resource Environment Providers**.
86

97
2. Select **WCM SearchService, Custom** properties.
108

119
3. Specify values for the search parameters.
1210

1311
- **SearchService.DateFormatString**
1412

15-
This parameter is used to set the date format when dates are entered in search forms. Enter a supported Java date format string. If this property is not set, then the default format is `MMM dd yyyy HH:mm:ss z`.
13+
Use this parameter to set the date format when dates are entered in search forms. Enter a supported Java date format string. If this property is not set, then the default format is `MMM dd yyyy HH:mm:ss z`.
1614

1715
- **SearchService.RecrawlInterval**
1816

@@ -24,7 +22,7 @@ You can edit the following search options to manage how the search service works
2422

2523
- **SearchService.MetaFields**
2624

27-
This parameter is used to specify extra elements to crawl when searching for metadata.
25+
Use this parameter to specify extra elements to crawl when searching for metadata.
2826

2927
The format for this parameter value is: `elementName,key1`
3028

@@ -34,14 +32,14 @@ You can edit the following search options to manage how the search service works
3432
elementName1,key1;elementName2,key2;elementName3,key3
3533
```
3634
37-
For example, to crawl for metadata in a text element named metaText:
35+
For example, to crawl for metadata in a text element named `metaText`:
3836
39-
- ```
40-
SearchService.MetaFields=metaText,meta
41-
```
37+
```
38+
SearchService.MetaFields=metaText,meta
39+
```
4240
43-
- `elementName` is the name of element you would like to search for metadata. Any valid element with that name in a searchable site area or content item is crawled.
44-
- `key` is the "key" that is specified in an element tag that is used as part of a search element design. In the previous example, the key of "meta" is used. To render the content of the metaText element in a search element design, you would use the following tag: `<Element context="autoFill" type="content" key="meta"/>`
41+
- `elementName` is the name of the element you would like to search for metadata. Any valid element with that name in a searchable site area or content item is crawled.
42+
- `key` is the key specified in an element tag that is used as part of a search element design. In the previous example, the key `meta` is used. To render the content of the `metaText` element in a search element design, use the following tag: `<Element context="autoFill" type="content" key="meta"/>`
4543
4644
!!! note
4745
- Only text elements and short text elements can be searched.
@@ -50,22 +48,23 @@ SearchService.MetaFields=metaText,meta
5048
- **SearchService.SearchSeed.ExcludeFileAttachments**
5149
5250
Set this parameter to `true` to prevent file resource component attachments from being included in the search results.
53-
54-
If set to false, the files that are stored in file resource elements in content items can also be searched. Files that are stored in file resource elements in a site area can also be searched so long as a default content item is selected.
51+
52+
Set this parameter to `false` to make files stored in file resource elements in content items searchable. Files stored in file resource elements in a site area also become searchable if a default content item is selected.
5553
5654
- **SearchService.SearchSeed.excludeExtensions**
5755
5856
Set this parameter to a list of file name extensions that you want to exclude from search results. Separate each item in the list with a comma. Any file resource component attachments and file resource element attachments that have these extensions are excluded from search results. For example, `SearchService.SearchSeed.excludeExtensions=avi,mpeg,zip`.
5957
6058
- **Searchservice.searchseed.excludeContentResourceTypeElement**
6159
62-
Set this parameter to true to exclude the default file resource element of a content item which is set to resource type from the seedlist, since the default file resource element is already being pointed to by the content item. The default setting is false.
60+
Set this parameter to `true` to exclude the default file resource element of a content item that is already included through its resource type from the seedlist. The default file resource element is excluded since it is already being pointed to by the content item. The default setting is `false`.
6361
64-
4. Click **Apply** and then **OK**.
62+
- **Searchservice.SearchSeed.excludeFields**
6563
66-
5. Restart the portal for the new settings to take effect.
67-
68-
6. Delete and create a new search collection for changes to take effect.
64+
Set this parameter to a list of meta fields you want to exclude from the search seedlist.
6965
66+
4. Click **Apply** > **OK**.
7067
68+
5. Restart the portal for the new settings to take effect.
7169
70+
6. Delete and create a new search collection for changes to take effect.

docs/build_sites/search/crawling_webcontent_seedbase/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Search seedlist 1.0 can make access control information available in a way that
99
!!! important
1010
When changing access control on libraries or setting access on the library root, note that seedlist requests relative to a timestamp will not list items affected by an access control change. To retrieve those updates, it is recommended to trigger a full crawl.
1111
DX classic Search, either local or remote, uses post-access control filtering and is therefore not affected.
12+
Starting CF225, you can have the seedlist return items affected by library access control changes. To enable this feature, set ```seedlistUpdateLibrariesForAccessControl=true``` in `WCM WCMConfigService`.
1213

1314

1415
- **[The search seedlist 1.0 format](../crawling_webcontent_seedbase/wcm_searchseed/index.md)**

docs/build_sites/search/improving_search_quality/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This topic provides information on how you can improve search quality in HCL Digital Experience and Web Content Manager Search.
66

7-
The quality of search is based primarily on the relevance scoring methods within HCL Digital Experience and the Web Content Manager Search component. The search applies standard relevance calculation provided by the underlying open source [Lucene search engine](http://http//lucene.apache.org).
7+
The quality of search is based primarily on the relevance scoring methods within HCL Digital Experience and the Web Content Manager Search component. The search applies standard relevance calculation provided by the underlying open source [Lucene search engine](https://lucene.apache.org){target="_blank"}.
88

99
In general, terms are based on standard scoring **“tf x idf”** (term frequency times inverted document frequency). The structure of information provided in a document is not considered. For example, whether a keyword is found in the 'title' or any other structural element of the document. When a keyword appears in the title, it is assumed that this keyword is significant for this document as opposed to that same keyword appearing only in the document's regular body text. This section describes what search quality tuning options are available to improve the search quality.
1010

docs/build_sites/search_v2/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ nav:
66
- Using Search V2: usage.md
77
- Limitations of Search V2: limitations.md
88
- Components of Search V2: components.md
9+
- Customizations for Search V2: customizations.md

docs/build_sites/search_v2/components.md

Lines changed: 1 addition & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -230,113 +230,6 @@ Functional Composite Components (FCC) combine ACs to deliver higher-level functi
230230
|**searchResults** | DxSearchResults | Contains the search results, including hit count, individual hits, and scores. | { hits: { total: { value: NaN, relation: 'eq' }, max_score: 0, hits: [] } } |
231231
|**isLoading** | Boolean | A flag that indicates whether search results are being loaded. | false |
232232

233-
## Styling the search components
234-
235-
This section explains the default styles for search components and how to customize them.
236-
237-
### Default styling
238-
239-
Each component comes with default styles. See the following examples of different default styles below.
240-
241-
```scss
242-
/* for dx-search-center-layout */
243-
dx-search-center-layout::part(main) {
244-
display: flex;
245-
}
246-
/* for dx-input-textfield */
247-
dx-input-textfield::part(div) {
248-
width: 100%;
249-
position: relative;
250-
}
251-
/* for dx-button */
252-
dx-button::part(button) {
253-
@include button;
254-
}
255-
/* for dx-circular-progress */
256-
@keyframes rotateCircularProgress {
257-
100% {
258-
transform: rotate(360deg);
259-
}
260-
}
261-
/* for dx-header */
262-
dx-header::part(div) {
263-
width: 100%;
264-
position: relative;
265-
}
266-
/* for dx-chip */
267-
dx-chip::part(chip-div) {
268-
background-color: $BLACK8P;
269-
border-radius: 4px;
270-
display:inline-flex;
271-
padding:8px 8px 8px 8px;
272-
align-items: center;
273-
height: 16px;
274-
}
275-
/* for dx-avatar */
276-
dx-avatar::part(avatar-div) {
277-
height: 32px;
278-
width: 32px;
279-
border: 1px solid $avatar-border-color;
280-
box-sizing: border-box;
281-
display: flex;
282-
justify-content: center;
283-
align-items: center;
284-
}
285-
// for the input select fields
286-
dx-search-center-layout .search-input-div {
287-
display: flex;
288-
flex-direction: row;
289-
justify-content: space-between;
290-
291-
dx-search-input-scope,
292-
dx-search-input-type {
293-
display: flex;
294-
align-self: center;
295-
max-width: 49%;
296-
width: 49%;
297-
}
298-
}
299-
// for the input query field and button
300-
dx-search-center-layout div.search-input-div {
301-
display: flex;
302-
flex-direction: row;
303-
justify-content: space-between;
304-
305-
dx-search-input-query {
306-
display: flex;
307-
align-self: center;
308-
width: calc(100% - 125px);
309-
max-width: calc(100% - 125px);
310-
}
311-
```
312-
313-
314-
### Style customization
315-
316-
You can override styles by targeting the component's class names. Other components can be overridden in a similar manner. Refer to the styling examples below for `dx-button` and `dx-input-textfield`.
317-
318-
!!! note
319-
The `part` attribute is used to name parts of a shadow tree, which can then be styled from outside the shadow DOM using the `::part()` pseudo-element. This allows you to apply CSS styles to shadow tree elements from the parent DOM.
320-
321-
```css
322-
/* for dx-button */
323-
dx-button::part(button-start-icon) {
324-
color: #FBCD00; /* change the color as per your requirements and also other things can be changed */
325-
height: 16px;
326-
margin-right: 4px;
327-
width: 16px;
328-
}
329-
/* for dx-input-textfield */
330-
dx-input-textfield::part(label) {
331-
@include font-default;
332-
width: 100%;
333-
margin-bottom: 16px;
334-
display: red;
335-
color: #AFC002;
336-
}
337-
338-
```
339-
340233
## Theme modules
341234

342235
Search components are provided using theme modules, allowing users to create custom stylesheets for all components. This flexibility is ideal for adapting the search functionality to match your application's design. For more information about themes and skins in DX, refer to [Developing themes and skins](../../build_sites/themes_skins/index.md).
@@ -400,44 +293,11 @@ You can use the default theme modules (CSS and JS files) provided to you as-is,
400293

401294
![](../../assets/HCL_Search_Get_Theme_Modules_12.png "Open the `default.css` file you have downloaded in a code editor such as Visual Studio Code")
402295

403-
See the sample view of the formatted CSS file.
296+
See the sample view of the formatted `default.css` file.
404297

405298
![](../../assets/HCL_Search_Get_Theme_Modules_13.png "Log in to HCL Digital Experience 9.5 and Go to the Search V2 UI")
406299

407300

408-
## Using and customizing the theme modules
409-
410-
Follow these steps to use the theme module files you downloaded on your new or existing theme pages.
411-
412-
!!!note
413-
Ensure you have downloaded the `dx_search_css` and `dx_search_js` files from [Getting the default theme modules](#getting-the-default-theme-modules) and saved the files as `default.css` and `index.js` respectively.
414-
415-
1. Open the `default.css` file and update the styles in the file as needed.
416-
417-
- You can also create your own CSS file, such as `custom-theme.css`, where you can add your overrides, using the `default.css` as your guide for the base styles.
418-
419-
2. Link the default and custom CSS files in your application's HTML code as follows.
420-
421-
```html
422-
<link rel="stylesheet" href="/path/to/default.css">
423-
<link rel="stylesheet" href="/path/to/custom-theme.css">
424-
```
425-
426-
3. Download the default theme CSS `dx_search_js` from the provided location as `index.js`.
427-
428-
4. Add the script to your application's html head.
429-
```html
430-
<script type="module" src="/path/to/index.js"></script>
431-
```
432-
433-
See the sample customized CSS code which changed the background color dx-search-center-layout component.
434-
435-
```css
436-
dx-search-center-layout::part(main) {
437-
background-color: #f0f0f0;
438-
}
439-
```
440-
441301
## Communication between components using the Broadcast Channel API
442302

443303
Search V2 utilizes the Broadcast Channel API for its components. The Broadcast Channel API provides real-time synchronization, updating search search results when a new query is entered. It has a decoupled design that allows FCC components to work independently and communicate without direct references.

0 commit comments

Comments
 (0)