Skip to content

Commit

Permalink
feat(zebe): improve tooltips content
Browse files Browse the repository at this point in the history
  • Loading branch information
@smbea
smbea committed Aug 23, 2023
1 parent 48f45b8 commit 8a50323
Showing 1 changed file with 93 additions and 48 deletions.
141 changes: 93 additions & 48 deletions src/contextProvider/zeebe/TooltipProvider.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,38 @@ const TooltipProvider = {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/user-tasks/#assignments" target="_blank" rel="noopener" title={ translate('User task documentation') }>
{ translate('How to configure a user task') }
</a>
<div>
{ translate('Define who the task is assigned to. One or all of the following attributes can be specified simultaneously. ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/user-tasks/#assignments" target="_blank" rel="noopener" title={ translate('User task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

'group-condition': (element) => {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/exclusive-gateways/#conditions" target="_blank" rel="noopener" title={ translate('Conditions documentation') }>
{ translate('How to define conditions') }
</a>
<div>
{ translate('Define a boolean condition expression that defines when a flow is taken. ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/exclusive-gateways/#conditions" target="_blank" rel="noopener" title={ translate('Conditions documentation') }>
{ translate('How to define conditions') }
</a>
</div>
);
},

'group-businessRuleImplementation': (element) => {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/business-rule-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Business rule task documentation') }>
{ translate('How to configure a business rule task') }
</a>
<div>
{ translate('Evaluate a business rule, for example a DMN. To add a custom implementation use a job worker. ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/business-rule-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Business rule task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);

},
Expand All @@ -44,9 +53,12 @@ const TooltipProvider = {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/guides/utilizing-forms/#connect-your-form-to-a-bpmn-diagram" target="_blank" rel="noopener" title={ translate('User task form documentation') }>
{ translate('How to link a form') }
</a>
<div>
{ translate('Embed Camunda Forms or use a form key to specify an identifier to associate a form to the user task. ')}
<a href="https://docs.camunda.io/docs/guides/utilizing-forms/#connect-your-form-to-a-bpmn-diagram" target="_blank" rel="noopener" title={ translate('User task form documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

Expand All @@ -55,26 +67,36 @@ const TooltipProvider = {

if (is(element, 'bpmn:ReceiveTask')) {
return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/receive-tasks/#messages" target="_blank" rel="noopener" title={ translate('Receive task documentation') }>
{ translate('How to configure a receive task') }
</a>
<div>
{ translate('Define the name of the message (e.g. ')}<code>Money collected</code>{translate(') and the ')}<code>correlationKey</code>{translate(' expression (e.g. ')}<code>= orderId</code>{translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/receive-tasks/#messages" target="_blank" rel="noopener" title={ translate('Receive task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/message-events/#messages" target="_blank" rel="noopener" title={ translate('Message event documentation') }>
{ translate('How to configure a message event') }
</a>
<div>
{ translate('Define the name of the message (e.g. ')}<code>Money collected</code>{translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/message-events/#messages" target="_blank" rel="noopener" title={ translate('Message event documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

'group-calledElement': (element) => {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/call-activities/" target="_blank" rel="noopener" title={ translate('Call activity documentation') }>
{ translate('How to call another process') }
</a>
<div>
{ translate('Define the BPMN process id of the called process (e.g. ')} <code>shipping-process</code>
{translate(' or ')}<code>= "shipping-" + tenantId</code> {translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/call-activities/" target="_blank" rel="noopener" title={ translate('Call activity documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

Expand All @@ -84,41 +106,51 @@ const TooltipProvider = {

if (is(element, 'bpmn:ServiceTask')) {
return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/service-tasks/#task-definition" target="_blank" rel="noopener" title={ translate('Service task documentation') }>
{ translate('How to configure a service task') }
</a>
<div>{translate('Specify which job workers handle the task work (e.g. ')}<code>order-items</code>{translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/service-tasks/#task-definition" target="_blank" rel="noopener" title={ translate('Service task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}

if (is(element, 'bpmn:BusinessRuleTask')) {
return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/business-rule-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Business rule task documentation') }>
{ translate('How to configure a business rule task') }
</a>
<div>{translate('Specify which job workers handle the task work. ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/business-rule-tasks/#job-worker-implementation" target="_blank" rel="noopener" title={ translate('Business rule task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}

if (is(element, 'bpmn:ScriptTask')) {
return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/script-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Script task documentation') }>
{ translate('How to configure a script task') }
</a>
<div>{translate('Specify which job workers handle the task work (e.g. ')}<code>script</code>{translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/script-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Script task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}

if (is(element, 'bpmn:SendTask')) {
return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/send-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Send task documentation') }>
{ translate('How to configure a send task') }
</a>
<div>{translate('Specify which job workers handle the task work (e.g. ')}<code>kafka</code>{translate(' or ')}<code>mail</code>{translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/send-tasks/#defining-a-task" target="_blank" rel="noopener" title={ translate('Send task documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}

if (is(element, 'bpmn:ThrowEvent')) {
return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/message-events/#message-throw-events" target="_blank" rel="noopener" title={ translate('Message throw event documentation') }>
{ translate('How to configure a message throw event') }
</a>
<div>{translate('Specify which job workers handle the event work. ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/message-events/#message-throw-events" target="_blank" rel="noopener" title={ translate('Message throw event documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}
},
Expand All @@ -127,39 +159,52 @@ const TooltipProvider = {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/multi-instance/#defining-the-collection-to-iterate-over" target="_blank" rel="noopener" title={ translate('Multi instance documentation') }>
{ translate('How to configure a multi instance activity') }
</a>
<div>
{translate('Define an input collection expression that defines the collection to iterate over (e.g. ')}<code>= items</code>{translate('). ')}
{translate('To collect the output define the output collection and the output element expressions. ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/multi-instance/#defining-the-collection-to-iterate-over" target="_blank" rel="noopener" title={ translate('Multi instance documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

'group-error': (element) => {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/error-events/#defining-the-error" target="_blank" rel="noopener" title={ translate('Error event documentation') }>
{ translate('How to configure an error event') }
</a>
<div>
{translate('Define an error code (e.g. ')}<code>order-not-found</code>{translate('). ')}
<a href="https://docs.camunda.io/docs/components/modeler/bpmn/error-events/#defining-the-error" target="_blank" rel="noopener" title={ translate('Error event documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

'group-inputs': (element) => {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/concepts/variables/#input-mappings" target="_blank" rel="noopener" title={ translate('Input mappings documentation') }>
{ translate('How to configure input variable mappings') }
</a>
<div>
{ translate('Create a new local variable in the scope where the mapping is defined. ')}
<a href="https://docs.camunda.io/docs/components/concepts/variables/#input-mappings" target="_blank" rel="noopener" title={ translate('Input mappings documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
},

'group-outputs': (element) => {
const translate = useService('translate');

return (
<a href="https://docs.camunda.io/docs/components/concepts/variables/#output-mappings" target="_blank" rel="noopener" title={ translate('Output mappings documentation') }>
{ translate('How to configure output variable mappings') }
</a>
<div>
{ translate('Customize how job/message variables are merged into the process instance. ')}
<a href="https://docs.camunda.io/docs/components/concepts/variables/#output-mappings" target="_blank" rel="noopener" title={ translate('Output mappings documentation') }>
{ translate('Learn more.') }
</a>
</div>
);
}
};
Expand Down

0 comments on commit 8a50323

Please sign in to comment.