Skip to content

Commit

Permalink
[TASK] Update path to LUX images in documentation
Browse files Browse the repository at this point in the history
To improve rendering for docs.typo3.org
  • Loading branch information
einpraegsam committed Jan 16, 2025
1 parent 8c0e864 commit ca916a2
Show file tree
Hide file tree
Showing 33 changed files with 120 additions and 120 deletions.
4 changes: 2 additions & 2 deletions Documentation/Developer/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## How to develop with LUX

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Marketing/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## Marketing documenation

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/Commands.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## User information

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/DoNotTrack.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## DoNotTrack Header

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/FingerprintsAndLocalStorage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## Introduction

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

This part of the documentation gives you some information about privacy on websites in general.

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/IpAddresses.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## IP addresses

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/OptInAndOptOut.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

## Tracking Opt-Out and Opt-In

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Privacy/PrivacyPage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

### Example part for your privacy page

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Technical/API/Create.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

# Endpoint "create" to write new or update existing leads into database (writing access)

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Technical/API/FindAllByAnyProperties.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

# Endpoint "findAllByAnyProperties" for getting a list of visitors (reading access)

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Technical/API/FindByProperty.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

# Endpoint "findByProperty" for getting a single visitor (reading access)

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Technical/API/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

# API and Interface from LUX (only in luxenterprise)

Expand Down
20 changes: 10 additions & 10 deletions Documentation/Technical/Analysis/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

### Tracking and Analysis

Expand Down Expand Up @@ -68,7 +68,7 @@ plugin.tx_lux.settings {
```

Example page tracking request in browser console:
<img src="../../../Documentation/Images/documentation_installation_browserrequest.png" width="800" />
<img src="../../Images/documentation_installation_browserrequest.png" width="800" />



Expand All @@ -77,7 +77,7 @@ Example page tracking request in browser console:
#### Dashboard

Now, if LUX is up and running, you should see information in the Analysis Backend Module in the dashboard view:
<img src="../../../Documentation/Images/screenshot_analysis_dashboard.png" width="800" />
<img src="../../Images/screenshot_analysis_dashboard.png" width="800" />

The dashboard view should give you a quick overview about the latest activities and some useful information:
* How many recurring/unique leads
Expand Down Expand Up @@ -120,7 +120,7 @@ pages and assets for your leads.
Clicking on an asset or a page will open a detail page to this item, where you can exactly see which lead was interested
in this item.

<img src="../../../Documentation/Images/screenshot_analysis_content.png" width="800" />
<img src="../../Images/screenshot_analysis_content.png" width="800" />

**Technical note:** Page visits will be automatically be tracked with LUX on normal TYPO3 pages. In some rare scenarios
you may want to push an interaction (event) to LUX. This can be helpful if you want to track accordion opens, multistep
Expand Down Expand Up @@ -161,7 +161,7 @@ reacting to your filter settings. Of course, you can also use the CSV download i

Clicking on a lead will open a detail page to this lead.

<img src="../../../Documentation/Images/screenshot_analysis_utm.png" width="800" />
<img src="../../Images/screenshot_analysis_utm.png" width="800" />


#### Link Listeners
Expand All @@ -177,14 +177,14 @@ You can use the filter on the top for a perfect analysis in a timeframe or for a
a Link Listener in the table you will see the latest leads in a preview. If you click on "Show details" then, you will
see all leads that used the defined Link Listener.

<img src="../../../Documentation/Images/screenshot_analysis_linklisteners.png" width="800" />
<img src="../../Images/screenshot_analysis_linklisteners.png" width="800" />

##### How to change a link to a Link Listener Link?

That's very simple. Just add a new Link listener with a link target. After that, go to your RTE and set a link to your
new Listener. That's all. Now all clicks on this link are tracked now.

<img src="../../../Documentation/Images/screenshot_linklistener_link.png" />
<img src="../../Images/screenshot_linklistener_link.png" />


#### Search
Expand All @@ -198,7 +198,7 @@ You can use the filter on the top for a perfect analysis in a timeframe or for a
a row in the table you will see the latest leads in a preview. If you click on "Show details" then, you will
see all leads that used the search term.

<img src="../../../Documentation/Images/screenshot_analysis_search.png" width="800" />
<img src="../../Images/screenshot_analysis_search.png" width="800" />

To **track searchterms**, there are basically two different ways:

Expand Down Expand Up @@ -226,7 +226,7 @@ from LUX.

This is a screenshot from default values:

<img src="../../../Documentation/Images/screenshot_typo3dashboard.png" width="800" />
<img src="../../Images/screenshot_typo3dashboard.png" width="800" />

Available widgets:

Expand Down
8 changes: 4 additions & 4 deletions Documentation/Technical/Campaigns/AbTesting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

#### A/B testing

Expand All @@ -26,7 +26,7 @@ After that you will see some more fields. Add a title, a description and two pag
and select the current page, that you are editing. Add a title to page record 2 and also select page B.
Read for your first test.

<img src="../../../Documentation/Images/screenshot_abtesting_pagesettings.png" width="800" />
<img src="../../Images/screenshot_abtesting_pagesettings.png" width="800" />

| Field | Description |
|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -49,7 +49,7 @@ Read for your first test.

Once you have activated A/B tests in page properties, you will see a result in pageoverview:

<img src="../../../Documentation/Images/screenshot_abtesting_pageoverview.png" width="800" />
<img src="../../Images/screenshot_abtesting_pageoverview.png" width="800" />


##### Backend module
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Technical/Campaigns/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

### Marketing campaigns

Expand Down
8 changes: 4 additions & 4 deletions Documentation/Technical/Campaigns/UrlShortener.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

#### URL shorteners

Expand All @@ -13,7 +13,7 @@ of short URL usage per lead.
If you open the backend module campaigns you can switch to "URL shortener" by clicking the button on the top.
A list view is shown.

<img src="../../../Documentation/Images/screenshot_urlshortener_list.png" width="800" />
<img src="../../Images/screenshot_urlshortener_list.png" width="800" />

This view works basicly like every other view in Lux. You can filter your shorteners per searchterm, category or per
timeframe. Diagrams are showing you "overall usage", "top shortener" and visits from "socialmedia".
Expand All @@ -25,7 +25,7 @@ A click on an existing shortener will show you individual information about the
If you click on the edit icon symbol, the edit view is opened. This view is similar to the view if you add a new
shortener record.

<img src="../../../Documentation/Images/screenshot_urlshortener_edit.png" width="800" />
<img src="../../Images/screenshot_urlshortener_edit.png" width="800" />

| Field | Description |
|---------------|--------------------------------------------------------------------------------------|
Expand Down
8 changes: 4 additions & 4 deletions Documentation/Technical/Campaigns/UtmGenerator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

#### UTM generator

Expand Down Expand Up @@ -30,7 +30,7 @@ campaigns.
If you open the backend module campaigns you can switch to "UTM Generator" by clicking the button on the top.
Another list view is shown.

<img src="../../../Documentation/Images/screenshot_utmgenerator_list.png" width="800" />
<img src="../../Images/screenshot_utmgenerator_list.png" width="800" />

This view works basicly like every other list view in Lux. You can filter your URI records by adding a searchterm.
Every table row shows the campaign name and the first available URI. By clicking on the plus symbol, all available
Expand All @@ -44,7 +44,7 @@ This view is similar to the view if you add a new shortener record.
**Note:** You have to add records of type `Campaign (UTM)`, `Source (UTM)` and `Medium (UTM)` first with the list view
module of TYPO3 to any folder page. Those records can be then selected in the edit view.

<img src="../../../Documentation/Images/screenshot_utmgenerator_edit.png" width="800" />
<img src="../../Images/screenshot_utmgenerator_edit.png" width="800" />

| Field | Description |
|-------------|----------------------------------------------|
Expand Down
12 changes: 6 additions & 6 deletions Documentation/Technical/Campaigns/Workflows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

#### Workflows

Expand All @@ -15,7 +15,7 @@ If you open the backend module workflows and you have not added any workflows ye
you is to add a new workflow. If you have already added one or more workflows, you will see a list of your existing
workflows.

<img src="../../../Documentation/Images/screenshot_workflow_list.png" width="800" />
<img src="../../Images/screenshot_workflow_list.png" width="800" />

Existing workflows can be deleted or edited by clicking the buttons.
If you edit an existing workflow or if you add a new workflow, you will see a form that is splitted into three
Expand All @@ -24,7 +24,7 @@ different steps.
##### 1 Title

Define a title and an internal description for your new workflow:
<img src="../../../Documentation/Images/documentation_workflow_edit_step1.png" width="800" />
<img src="../../Images/documentation_workflow_edit_step1.png" width="800" />

After that you can choose next for step 2.

Expand All @@ -37,7 +37,7 @@ should result in an action (see 3 Action).
Choose a trigger and click on the **+** button. Now a new trigger configuration was added. Depending on the trigger that
you have chosen, it's possible to add values to the trigger itself. In this example, we choose the *If a lead gets
identified* trigger - no values to add here:
<img src="../../../Documentation/Images/documentation_workflow_edit_step2.png" width="800" />
<img src="../../Images/documentation_workflow_edit_step2.png" width="800" />

Possible triggers by default are:
* Lead properties: If a lead gets identified
Expand Down Expand Up @@ -82,7 +82,7 @@ some variables in the bodytext.
On the right there are general options. You can select of this action should only be executed once per lead or more
often. Some actions are supporting also a delayed execution where you can specify a day and a time.

<img src="../../../Documentation/Images/documentation_workflow_edit_step3.png" width="800" />
<img src="../../Images/documentation_workflow_edit_step3.png" width="800" />

Possible actions by default are:
* Content manipulation: Open a popup (lightbox) with a content element
Expand Down
12 changes: 6 additions & 6 deletions Documentation/Technical/Categoryscorings/Index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX")
![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX")
![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX")

### Scoring and Categoryscoring

Expand Down Expand Up @@ -28,7 +28,7 @@ ago. That means that you have to call a CommandController once a day (or night)
The general scoring is visible on different views in Lux. Mostly beside the lead identification.
The value in the grey badge reflects the general scoring. The value in the blue badge reflects the hottest category
scoring:
<img src="../../../Documentation/Images/documentation_scoring.png" />
<img src="../../Images/documentation_scoring.png" />



Expand All @@ -50,10 +50,10 @@ What can we do with the knowledge about leads and their category scoring? Lux is
You can simply define some lux-categories in your TYPO3. A lux-category is just a sys_category record in TYPO3.
Don't forget to check the checkbox "lux-category".

<img src="../../../Documentation/Images/documentation_categoryscorings_categories.png" width="800" />
<img src="../../Images/documentation_categoryscorings_categories.png" width="800" />

After you added some lux-categories to your system, you can mark pages and files with that categories.
<img src="../../../Documentation/Images/documentation_categoryscorings_page.png" width="800" />
<img src="../../Images/documentation_categoryscorings_page.png" width="800" />

##### Calculation

Expand All @@ -68,4 +68,4 @@ If you want to change the factors, you can do this in the Extension Manager in t

Just open a lead detail-view. You will see all relevant information about category scorings to this lead.

<img src="../../../Documentation/Images/documentation_categoryscorings_detail.png" width="800" />
<img src="../../Images/documentation_categoryscorings_detail.png" width="800" />
Loading

0 comments on commit ca916a2

Please sign in to comment.