Transaction monitor- dev #46
Conversation
Transaction Monitor -Central Pane elements
IanWhyte
left a comment
IanWhyte
left a comment
There was a problem hiding this comment.
I endeavored to provide an explanation for my editing choices, either in the form of a link to a section in Style Guide or in the Git comment itself. But if you have ay questions, for sure, let me know - editing is a team sport.
|
|
||
| * The blue copy icon icon:plus-square-o[role="blue"] allows you to copy information to your clipboard | ||
| * The blue share icon icon:share[role="blue"] opens a detail pane that shows the complete message payload. | ||
| * *Document ID*- Unique copyable document identification. |
There was a problem hiding this comment.
Best as a definition list - see https://docs.google.com/document/d/1aLM3e7ocmmuaC2deAycPScSzaRyf0KCIdWV4YftI-VY/edit?usp=sharing
If the appearance of a field in the pane is record-dependent, we should state that. It might be useful to create a table that shows which fields appear for which records; if you were to try that, the fields would have to be the rows (because there are so many), and the records the columns.
|
|
||
| ==== *Detail Pane Action Icons* | ||
|
|
||
| * The *blue copy icon* icon:plus-square-o[role="blue"] allows you to copy information to your clipboard |
There was a problem hiding this comment.
Period at end (if the content of a bullet is a complete sentence, it always gets an ending period).
|
|
||
| ==== Buttons | ||
| ==== *Buttons* | ||
| * A *Transaction* icon:exchange[] button will appear when a document is selected |
There was a problem hiding this comment.
c/will appear/appears/
See https://docs.google.com/document/d/1HyhkDiMzD57DwDXa6R-HUd_f1weAfKKCwFh0RX57yEk/edit#heading=h.hbqr9i6r933j.
| ==== Buttons | ||
| ==== *Buttons* | ||
| * A *Transaction* icon:exchange[] button will appear when a document is selected | ||
| ** This will take you to the xref:central-pane-elements#transactions-view[Transactions View] and highlight this specific document |
There was a problem hiding this comment.
c/will take/takes/
Also, because you only have one bullet in each of these lists, you can (and should make this a single un-bulleted sentence. So:
A Transaction button appears when a document is selected; this takes you to the Transactions View and highlights this specific document.
See https://drive.google.com/a/modusbox.com/open?id=1aLM3e7ocmmuaC2deAycPScSzaRyf0KCIdWV4YftI-VY
| . *To:* Who the transaction was going to | ||
| . *Date:* Date and time at which the error occurred | ||
| . *Error Code:* Code associated with the error | ||
| . *From-* Who the transaction came from |
There was a problem hiding this comment.
Best as a definition list - see
https://drive.google.com/file/d/1H8dLWGi-F8AllbBeLtGNWwmlaBTW3x54/view?usp=sharing and
https://docs.google.com/document/d/1aLM3e7ocmmuaC2deAycPScSzaRyf0KCIdWV4YftI-VY/edit?usp=sharing
c/Who the transaction was going to/To whom the transaction was going/
c/Who the transaction came from/From whom the transaction came/
Best to avoid ending a sentence with a preposition: see https://docs.google.com/document/d/1HyhkDiMzD57DwDXa6R-HUd_f1weAfKKCwFh0RX57yEk/edit#heading=h.1clsts64j7pj
Also, when a pronoun is a direct or indirect object in a sentence, it takes the objective case.
|
|
||
| Relationship:: Filter by the application or partner between which the transaction occurs. | ||
| * Choose the Partner or Application from the dropdown menu | ||
| * Choose the Partner or Application from the dropdown menu. |
There was a problem hiding this comment.
Delete bullet. So:
To filter by the application or partner between which the transaction occurs, choose the Partner or Application from the dropdown menu.
| * The blue share icon icon:share[role="blue"] opens a detail page that shows the complete message payload. | ||
| ==== *Detail Pane Action Icons* | ||
| * The *blue copy icon* icon:plus-square-o[role="blue"] allows you to copy information to your clipboard | ||
| * The *blue arrow icon* icon:share[role="blue"] opens a detail page that shows the complete message payload. |
There was a problem hiding this comment.
c/allows/enables/ - people prefer to be enabled more than to be allowed
|
|
||
| ==== Buttons | ||
| ==== *Buttons* | ||
| * A *Transaction* icon:exchange[] button will appear when a transmission is selected |
There was a problem hiding this comment.
present tense (not future)
| ==== Buttons | ||
| ==== *Buttons* | ||
| * A *Transaction* icon:exchange[] button will appear when a transmission is selected | ||
| ** This will take you to the xref:central-pane-elements#transactions-view[Transactions View] and highlight this specific transmission |
| @@ -50,11 +62,11 @@ View:: | |||
| * Partners | |||
There was a problem hiding this comment.
Under Custom Range, use def list
…egration/modusbox-docs into transaction-monitor-2.0 # Conflicts: # portx/modules/ROOT/pages/_partials/documents-view.adoc # portx/modules/ROOT/pages/_partials/errors-view.adoc # portx/modules/ROOT/pages/_partials/transactions-view.adoc # portx/modules/ROOT/pages/_partials/transmissions-view.adoc
2 participants
Adding screen shots back to Central Pane Elements
Editing lists on 4 partials in central pane elements