Commenting your Models
General
The comment boxes in SmartPLS allow users to add supplementary information to their models in a format similar to a digital post-it. This feature is useful for keeping detailed notes about your analyses, providing explanations, or documenting the rationale behind certain modeling decisions directly within the SmartPLS environment.
- To add comments to your model in SmartPLS, simply click on the
Commentbutton in the toolbar and place a comment field in your model. - To edit an existing comment, double-click on it.
How can I format text in a comment box?
The comment boxes support Markdown syntax, making it easy to format your text. With Markdown, you can emphasize text using bold or italics, create bullet points or numbered lists, and more. For instance:
Here are some examples:
# Heading Level 1
## Heading Level 2
### Heading Level 3
**Bold Text**
_Italic Text_
And you can use
1., 2., 3. for numbered lists, and - or * for bullet points.Can I include hyperlinks in my comment boxes?
Yes! You can include hyperlinks using Markdown. Simply use the format
[SmartPLS software link](https://www.smartpls.com)
and it will transform into a clickable link in the comment box. This is especially useful for referencing external resources or supplementary information.
Is it possible to include images in a comment box?
Absolutely. You can embed images in your comment boxes using Markdown syntax. To do so, use the format
Images can be a valuable way to enrich your documentation by providing visual context or additional analysis insights.
Are there any tips for utilizing comment boxes effectively?
- Be Concise: Use the comment boxes to jot down key information without overwhelming the space.
- Use Formatting Sparingly: Overusing formatting can make the comment hard to read, so use it to highlight only the most important points.
- Organize Information: Consider using bullet points or numbered lists for clarity, especially when documenting steps or instructions.
By leveraging the comment box feature in SmartPLS and the flexibility of Markdown syntax, you can enhance your documentation and make your models more informative and easier to understand.
