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.

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

update supp1 command examples #70

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
32 changes: 21 additions & 11 deletions content/en/embed_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,30 +48,40 @@ Insert the selected document from the given repository and branch inside the `HT
The Object file is stored in the **LwM2M-Object** repository, in the **master** branch (which is omitted), and inside a folder called **Device**.

### :SUPP1
This instruction inserts an `XML` file stored on a `branch` or `release tag` into a `HTML` document.
This instruction inserts an `XML` file into HTML from the specified repository, chosen `branch` or `release tag`, and selected`folder`.

```md
{:supp1 [Repository_Name]/[Branch_Name] | [Release_Name] [File_Name.xml]}
{:supp1 [Repository_Name]/[Branch_Name] | [Release_Name] [Folder_Name]/[File_Name.xml]}
```

### :SUPP1 Examples:
In this example, the file to insert is stored in a `branch`.
To insert a file from a root folder of a chosen `branch`, utilize the command below.

```md
{:supp1 objects-lwm2m/dev LWM2M_Access_Control.xml}
{:supp1 objects-lwm2m/master 25.xml}
```
* `Repository_Name`: **objects-lwm2m**
* `Branch_Name`: **dev**
* `File_Name`: **LWM2M_Access_Control.xml**
* `Branch_Name`: **master**
* `File_Name`: **25.xml**

In this example, the file to insert is stored in a `release tag` instead of a branch..

```md
{:supp1 objects-lwm2m/v1_1 LWM2M_Access_Control.xml}
{:supp1 EventLog/V2_1-20230131-A SUP/20.xml}
```
In this example, the file to insert is stored in a `release tag` instead of a branch.
* `Repository_Name`: **EventLog**
* `Release_Name`: **V2_1-20230131-A**
* `File_Name`: **20.xml**

* `Repository_Name`: **objects-lwm2m**
* `Release_Name`: **v1_1**
* `File_Name`: **LWM2M_Access_Control.xml**
If the file to insert is stored in a `folder` use the following.

```md
{:supp1 EventLog/development SUP/20.xml}
```
* `Repository_Name`: **EventLog**
* `Branch_Name`: **development**
* `Folder_Name`: **SUP**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* `Folder_Name`: **SUP**
* `Branch_Name`: **development**
* `Folder_Name`: **SUP**

Copy link
Collaborator

Choose a reason for hiding this comment

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

@gocadimic Branch_Name was missing.

Copy link
Collaborator

Choose a reason for hiding this comment

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

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@jpradocueva, resolved. Please review

* `File_Name`: **20.xml**

### :SUPP3
This instruction inserts any file type (.xml; .xsd; .html; etc.), from a selected repository and branch and optional `folder` into an `HTML` document.
Expand Down
Loading