Skip to content

Commit

Permalink
Change default alerts to plugin alerts
Browse files Browse the repository at this point in the history
  • Loading branch information
k-awata committed Oct 19, 2023
1 parent b9a838d commit 8e0391e
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 35 deletions.
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-plugin-flexible-alerts@1/dist/docsify-plugin-flexible-alerts.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code@2/dist/docsify-copy-code.min.js"></script>
</body>

Expand Down
6 changes: 3 additions & 3 deletions docs/mac/fescheck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,15 @@ You can approve an errors instead of solving them by fixing the PIPE.

![Approving Error](assets/approve.gif)

!> To complete checking after approving all the errors, click the **Recheck** button.
> [!NOTE] To complete checking after approving all the errors, click the **Recheck** button.
### Outputting ISO Drawings

When the macro checks a PIPE, it also outputs the ISO drawings.

![Outputting ISO](assets/output_iso.gif)

!> If the PIPE still has errors, the macro writes `DRAFT` on the ISO drawings.
> [!NOTE] If the PIPE still has errors, the macro writes `DRAFT` on the ISO drawings.
## Configuration

Expand Down Expand Up @@ -141,4 +141,4 @@ show !!feschecksettings

If an error of checking PIPEs matches with **Name**, **Check**, **Code**, and **Detail** of any row in this list, the error is automatically approved with the values of **Approved by** and **Reason of Approval**.

!> You can use the wildcard characters `*` in the values of **Name**, **Check**, **Code**, and **Detail**.
> [!NOTE] You can use the wildcard characters `*` in the values of **Name**, **Check**, **Code**, and **Detail**.
4 changes: 2 additions & 2 deletions docs/mac/fessupp/admin-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

To copy the `SDSConfig` folder from the `%PMLLIB%` directory to the `%<project>DFLTS%` directory, click this button.

!> For details of the `SDSConfig` folder, see [Configuration Directory](config-dir.md#configuration-directory).
> [!TIP] For details of the `SDSConfig` folder, see [Configuration Directory](config-dir.md#configuration-directory).
- **Open Project Config Folder**

Expand All @@ -32,7 +32,7 @@

There are DB output files on this table. To import the DB output file, select the row > right-click on the table > click **Import**.

!> For details of the DB output file, see [DB Output Files Definition File](config-dir.md#db-output-files-definition-file).
> [!TIP] For details of the DB output file, see [DB Output Files Definition File](config-dir.md#db-output-files-definition-file).
### Model Data Converter Tab

Expand Down
4 changes: 2 additions & 2 deletions docs/mac/fessupp/catalog-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The way to create an ancillary catalog is almost the same as a normal piping cat
| OEND | DIST | Distance from an open end of `GENSEC` to the nearest ancillary |
| ANTY | WORD | Catalog generic type |

> If the `ANTY` parameter has one of the following values, it has a special meaning as below:
> [!NOTE] If the `ANTY` parameter has one of the following values, it has a special meaning as below:
>
> - `REST`: It does not appear on the support MTO.
> - `BOLT`: SDS considers it a bolting ancillary, such as a U bolt, U band, or flange band.
Expand All @@ -39,7 +39,7 @@ The way to create an ancillary catalog is almost the same as a normal piping cat

The `SPCO` elements for the ancillary catalogs must be in the `SPEC` element set to `SupportSpec` in `sdsconfig.csv`.

!> You can use the **Admin Tools** form to create the `SPCO` elements for ancillary catalogs. For details, see [Admin Tools Form](admin-form.md).
> [!TIP] You can use the **Admin Tools** form to create the `SPCO` elements for ancillary catalogs. For details, see [Admin Tools Form](admin-form.md).
## Base Plate Catalog

Expand Down
26 changes: 13 additions & 13 deletions docs/mac/fessupp/config-dir.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB%` directory. You can change the setting for each project by copying `SDSConfig` to the directory defined by the `%<project>DFLTS%` environment variable and editing the files in the copied `SDSConfig`.

!> You can use the **Admin Tools** form to copy `SDSConfig`. For details, see [Admin Tools Form](admin-form.md).
> [!TIP] You can use the **Admin Tools** form to copy `SDSConfig`. For details, see [Admin Tools Form](admin-form.md).
## Configuration File

Expand All @@ -14,7 +14,7 @@ The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB

This is a CSV file that is the [Ancillary Types Definition File](#ancillary-types-definition-file).

!> All the values as file paths are the **relative paths** from the CSV file itself.
> [!NOTE] All the values as file paths are the **relative paths** from the CSV file itself.
- `BasePlates`: _File path_

Expand Down Expand Up @@ -44,7 +44,7 @@ The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB

This is an image file to display that "There is nothing to show."

!> The format of all the image files must be **PNG (\*.png)** or **JPEG (\*.jpg)**, and their image size should be **300x300px**.
> [!NOTE] The format of all the image files must be **PNG (\*.png)** or **JPEG (\*.jpg)**, and their image size should be **300x300px**.
- `SpecialImage`: _File path_

Expand All @@ -62,7 +62,7 @@ The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB

This is an extra length required if either end of a `GENSEC` element has a field welded plate.

!> Real values as a **distance** and a **bore** should include unit symbols such as `mm`, `"`, or `in` because their amount depends on the units setting of each project.
> [!NOTE] Real values as a **distance** and a **bore** should include unit symbols such as `mm`, `"`, or `in` because their amount depends on the units setting of each project.
- `PaddingAroundView`: _Distance_

Expand All @@ -84,7 +84,7 @@ The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB

This is a PML **string** expression to set ancillaries' `Stext` attributes. When the expression is evaluated, the CE is an `ANCI` or `TRANCI` element that has a valid `Compref` attribute. Also, `\n` in the expression is replaced by the new line character.

!> For details of the PML expressions, see **_AVEVA E3D Design Help > DATABASE and DATA MANAGEMENT > Database Management Reference > Expressions_**
> [!TIP] For details of the PML expressions, see **_AVEVA E3D Design Help > DATABASE and DATA MANAGEMENT > Database Management Reference > Expressions_**
- `ForeignRefCond`: _PML expression_

Expand Down Expand Up @@ -117,7 +117,7 @@ The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB

This is an attribute name to show the detail text for the ancillary items in the support MTO.

!> You can also use a **pseudo attribute** as the attribute name.
> [!NOTE] You can also use a **pseudo attribute** as the attribute name.
- `MtoAncillaryMtext`: _String_

Expand Down Expand Up @@ -155,7 +155,7 @@ The SDS setting is configured by using the `SDSConfig` directory in the `%PMLLIB

If this is true, SDS forces the users to do **Getwork** and **Savework** whenever they try to create a new `SUPPO` element.

> All the CSV (\*.csv) files must follow the following rules. For your information, **_Microsoft Excel_** can save a valid CSV file.
> [!NOTE] All the CSV (\*.csv) files must follow the following rules. For your information, **_Microsoft Excel_** can save a valid CSV file.
>
> - The first row is the column names.
> - The delimiters are `,` comma.
Expand All @@ -170,7 +170,7 @@ This is a CSV file to define the ancillary types to show on the **Select Ancilla

This defines the ancillary type names to specific-choose a row of the CSV file. These values must be **unique** in this column.

!> If the ancillary type is the same name as the framework type or the hanger type, when SDS creates the ancillary, also it creates the framework or hanger.
> [!NOTE] If the ancillary type is the same name as the framework type or the hanger type, when SDS creates the ancillary, also it creates the framework or hanger.
- `description`: _String_

Expand Down Expand Up @@ -215,7 +215,7 @@ This is a CSV file to define the ancillary types to show on the **Select Ancilla

When SDS creates the ancillary's members, it reads these values **from left to right**. If the read value is the **SPCO name**, it finds the `SPCO` element in `SupportSpec` that matches the name and has the same bore as the attached piping, and then it creates the member whose `Spref` has the found `SPCO`. If the read value is the **DESP setter**, it sets the parameters to the `Desparam` attribute of the last created member.

!> For details of `SupportSpec`, see [Configuration File](#configuration-file).
> [!TIP] For details of `SupportSpec`, see [Configuration File](#configuration-file).
## Base Plate Types Definition File

Expand Down Expand Up @@ -291,7 +291,7 @@ This is a CSV file to define the framework types to show on the **Select Framewo
- The `GENSEC` element for putting ancillaries must be running straight between **north** and **south**, and the justification line must be on the `STRU` origin (Position of `STRU`).
- To show the material names on the support MTO, set the material names to the `Description` attributes of the `GENSEC` elements.

!> You can use the **Admin Tools** form to create framework data files. For details, see [Admin Tools Form](admin-form.md).
> [!TIP] You can use the **Admin Tools** form to create framework data files. For details, see [Admin Tools Form](admin-form.md).
## Hanger Types Definition File

Expand All @@ -317,7 +317,7 @@ This is a CSV file to define the hanger types used for the supports. It must hav

This defines the hanger data files. The hanger data file is an output `HANG` element as a text file. You can use the hanger data output from the `HANG` elements in the `%APS000%/aps7344_0001` database, which is in the **APS** project provided by AVEVA, or the same format as it.

!> You can use the **Admin Tools** form to create hanger data files. For details, see [Admin Tools Form](admin-form.md).
> [!TIP] You can use the **Admin Tools** form to create hanger data files. For details, see [Admin Tools Form](admin-form.md).
## DB Output Files Definition File

Expand All @@ -331,7 +331,7 @@ This is a CSV file to define the DB output files to show on the **Admin Tools**

This defines the 3-character module names. If the user is in the module, the DB output file is available on the form.

> To know the current module name, run the following command from **Command Window**:
> [!TIP] To know the current module name, run the following command from **Command Window**:
>
> ```pml
> q var !!module().appkey
Expand All @@ -341,7 +341,7 @@ This is a CSV file to define the DB output files to show on the **Admin Tools**

This defines the DB output files.

!> To create a DB output file, see **_AVEVA E3D Design Help > DESIGN and MODELLING > Data Check > DB Listing_**
> [!TIP] To create a DB output file, see **_AVEVA E3D Design Help > DESIGN and MODELLING > Data Check > DB Listing_**
- `description`: _String_

Expand Down
10 changes: 5 additions & 5 deletions docs/mac/fessupp/draw-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

When generating the drawings, the selected template in this drop-down list is used.

!> For details of the template `REGI` element, see [Template Registry](template-format.md#template-registry).
> [!TIP] For details of the template `REGI` element, see [Template Registry](template-format.md#template-registry).
- **Output REGI**

Expand Down Expand Up @@ -36,7 +36,7 @@

To execute one step of generating the drawing, click an item in this sub-menu.

!> For details of the steps of generating the drawing, see [Generating Drawing Methods](#generating-drawing-methods).
> [!TIP] For details of the steps of generating the drawing, see [Generating Drawing Methods](#generating-drawing-methods).
- **Output MTO**

Expand All @@ -46,7 +46,7 @@

To output the selected drawings as **PDF** files, click this one.

!> The plot style is defined by the `OutputPltsty` option. For details, see [Configuration File](config-dir.md#configuration-file).
> [!TIP] The plot style is defined by the `OutputPltsty` option. For details, see [Configuration File](config-dir.md#configuration-file).
- **Export to Excel**

Expand Down Expand Up @@ -90,13 +90,13 @@

Set the origin point symbols at the support origin.

!> To set the support origin at your desired ancillary, set the `Number` attribute of the `ANCI` element to `-1`.
> [!NOTE] To set the support origin at your desired ancillary, set the `Number` attribute of the `ANCI` element to `-1`.
- `.SetOriginToGrid()`

Set the dimensions from the origin to the nearest gridlines.

!> The place to search for the nearest gridline is a `GRDREF` element where the origin is located. If the two or more `GRDREF` are applicable, the used `GRDREF` is the one with the smallest volume. The search ignores gridlines whose `IDPlane` attribute is `-`.
> [!NOTE] The place to search for the nearest gridline is a `GRDREF` element where the origin is located. If the two or more `GRDREF` are applicable, the used `GRDREF` is the one with the smallest volume. The search ignores gridlines whose `IDPlane` attribute is `-`.
- `.DrawPipeEnds()`

Expand Down
4 changes: 2 additions & 2 deletions docs/mac/fessupp/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To install SDS, follow these steps:

1. Place the `fessupp` folder in a directory specified by the `PMLLIB` environment variable.

!> For details of the `PMLLIB` environment variable, see **_AVEVA E3D Design Help > SOFTWARE COSTOMISATION > PML Publisher > General Features of PML > Storing and Loading PML Files_**
> [!TIP] For details of the `PMLLIB` environment variable, see **_AVEVA E3D Design Help > SOFTWARE COSTOMISATION > PML Publisher > General Features of PML > Storing and Loading PML Files_**
2. Enter the following command in **Command Window** on E3D Design:

Expand Down Expand Up @@ -56,4 +56,4 @@ To prepare the sample drawing template for your project, follow these steps:

3. Import `/SDS-LIBRARIES` and `/SDS-PENSTYLES` from the table in the **Initial Settings** tab.

!> To use user-defined catalogs and drawing templates, see [Configuration Directory](config-dir.md).
> [!TIP] To use user-defined catalogs and drawing templates, see [Configuration Directory](config-dir.md).
12 changes: 6 additions & 6 deletions docs/mac/fessupp/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To open the SDS Design form, follow these steps:
show !!fessuppdes
```

!> To open an SDS macro form besides using the command, ask your E3D administrator or see **_AVEVA E3D Design Help > SOFTWARE COSTOMISATION > .NET Customisation > Edit an UIC File_**
> [!TIP] To open an SDS macro form besides using the command, ask your E3D administrator or see **_AVEVA E3D Design Help > SOFTWARE COSTOMISATION > .NET Customisation > Edit an UIC File_**
## Create SUPPO Element

Expand All @@ -24,7 +24,7 @@ To create a `SUPPO` element, follow these steps:

2. Enter a name to a new `SUPPO` in the **Name** box on the macro form.

!> You can name `SUPPO` by using `(Auto Name)` instead of manually naming. That automatically names `SUPPO` from a naming pattern of the first `SUPPO` in the owner `ZONE` element.
> [!NOTE] You can name `SUPPO` by using `(Auto Name)` instead of manually naming. That automatically names `SUPPO` from a naming pattern of the first `SUPPO` in the owner `ZONE` element.
3. Click <kbd>Create</kbd> next to the **Name** box.

Expand All @@ -40,11 +40,11 @@ To create a support ancillary to the current support, follow these steps:

3. Select an ancillary type from the list.

!> The ancillary types shown in the list can depend on the condition of the `BRAN` element that owns the picked piping element.
> [!NOTE] The ancillary types shown in the list can depend on the condition of the `BRAN` element that owns the picked piping element.
4. Click <kbd>OK</kbd> on the selection form.

!> If you have created the first ancillary of a `SUPPO` element, its position is at the arriving point of the picked piping element. To move the ancillary to the desired position, use the **Distance** box.
> [!NOTE] If you have created the first ancillary of a `SUPPO` element, its position is at the arriving point of the picked piping element. To move the ancillary to the desired position, use the **Distance** box.
## Create Support Framework

Expand All @@ -56,7 +56,7 @@ To create a support framework to the current support, follow these steps:

2. Select a framework type from the selection list.

!> If there are too many options in the list, you can use the **Filter** drop-down list next to <kbd>Create</kbd> to reduce them.
> [!TIP] If there are too many options in the list, you can use the **Filter** drop-down list next to <kbd>Create</kbd> to reduce them.
3. Click <kbd>OK</kbd> on the selection form.

Expand All @@ -74,7 +74,7 @@ To create a base plate to the current steel section, follow these steps:

4. Select a base plate type from the selection list.

!> The base plate types shown in the list can depend on the condition of the `GENSEC` element.
> [!NOTE] The base plate types shown in the list can depend on the condition of the `GENSEC` element.
5. Click <kbd>OK</kbd> on the selection form.

Expand Down
4 changes: 2 additions & 2 deletions docs/mac/fessupp/template-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The drawing templates must be in a `REGI` element whose `SpPurpose` attribute is `SUPP`. The `REGI` element can include multiple `DRWG` elements. Their usage depends on the `ViewScales` option.

!> For details of the `ViewScales` option, see [Configuration File](config-dir.md#configuration-file).
> [!TIP] For details of the `ViewScales` option, see [Configuration File](config-dir.md#configuration-file).
## Template Drawing

Expand Down Expand Up @@ -60,7 +60,7 @@ The `DRWG` element for the template drawing must have the following type and nam

SDS creates the detail-views in the area enclosed by this `RECT`.

!> If there are too many detail-views on one sheet, they might be created outside the area.
> [!WARNING] If there are too many detail-views on one sheet, they might be created outside the area.
- :city_sunset: **VIEW** `./S1/VP`

Expand Down

0 comments on commit 8e0391e

Please sign in to comment.