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.

Sign up for GitHub

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

[#53] Add section for reference frame #62

Closed
wants to merge 7 commits into from
Closed

[#53] Add section for reference frame #62

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bc37ef0
Add section for reference frame
mfjkri Jul 22, 2024
6203ddd
Update table format to use markdown
mfjkri Aug 15, 2024
782abd8
Use puml file for embedding sequence diagrams
mfjkri Aug 15, 2024
03bcc75
Move puml diagrams into plantuml directory
mfjkri Aug 15, 2024
b706cd4
Update references to plantuml diagrams
mfjkri Aug 15, 2024
e90357f
Add original reference diagram example
mfjkri Aug 20, 2024
6bb9b12
Update phrasing
mfjkri Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added tutorials/images/plantuml/ParentReferenceFrameDiagram.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/images/plantuml/ReferenceFrameDiagram.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions tutorials/plantUml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,51 @@ package "Rule Of Thumb";{

Explicitly define all symbols to avoid any potential layout mishaps.
</box>

### Using reference frames
mfjkri marked this conversation as resolved.
Show resolved Hide resolved

mfjkri marked this conversation as resolved.
Show resolved Hide resolved
mfjkri marked this conversation as resolved.
Show resolved Hide resolved
<table>
mfjkri marked this conversation as resolved.
Show resolved Hide resolved
<colgroup>
<col style="width: 70%" />
<col style="width: 30%" />
</colgroup>

<thead>
<tr class="header">
<th>Source</th>
<th>Result</th>
</tr>
</thead>

<tbody>

<tr class="odd">
<td>
<pre>
ref over MSLogic, TextUi : get minefield appearance
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A comment would be helping to tell students that this is for the reference frame only.
OR
Moreover, it might be better to simplify the image. It could focus on the section between :TextUi and :MsLogic. Then, include the entire code within the Source block, similar to how the full code for the overall image in above sections

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the suggestion!

I have went ahead and simplified the diagrams as much I could. I have not simplified it fully as I was concerned that it could undermine the example's relevance. If the diagrams are too simplified, it might be harder to see and connect the usage of reference frames in an actual use case.

Could you suggest any specific areas that could be removed, or do you think the current diagrams are sufficient?

</pre>
</td>
<td>
<img src="images/plantuml/ParentReferenceFrameDiagram.png">
mfjkri marked this conversation as resolved.
Show resolved Hide resolved
</td>
</tr>

<tr class="even">
<td>
<pre>
mfjkri marked this conversation as resolved.
Show resolved Hide resolved
group sd get minefield appearance
'Contents of reference frame
TextUi -> MSLogic : getAppearanceOfCellAt(x, y)
activate MSLogic
MSLogic --> TextUi : cellAppearance
deactivate MSLogic
end
</pre>
</td>
<td>
<img src="images/plantuml/ReferenceFrameDiagram.png">
</td>
</tr>

</tbody>
</table>