Skip to content

Commit

Permalink
Merge branch 'translate'
Browse files Browse the repository at this point in the history
更新翻译
  • Loading branch information
huuhghhgyg committed Feb 4, 2024
2 parents f63df7d + 1d6fb17 commit 692098b
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 51 deletions.
2 changes: 1 addition & 1 deletion docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ If you want to learn more about how to use MicroCity Web and its advanced featur
1. Go to the MicroCity documentation repository to download the [**Latest Version of MicroCity**](https://github.com/microcity/Desktop/releases/latest).

2. Open the ![icon](../images/doc/icon_script_editor.png)**ScriptEditor** and type:
```lua
```lua:no-line-numbers
Print("hello, world!")
```

Expand Down
6 changes: 3 additions & 3 deletions docs/en/notes/mip.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ mip:addrow('c2', 'bin')

Since the objective function and constraint equations have been added, solving the model is straightforward:

```lua
```lua:no-line-numbers
mip:solve()
```

Expand All @@ -153,13 +153,13 @@ After solving, you still need to output; otherwise, you won't know the results.

Get the **value of the objective function**:

```lua
```lua:no-line-numbers
mip['obj']
```

Get the value of the `i`-th **variable**:

```lua
```lua:no-line-numbers
mip['c'..i]
```

Expand Down
43 changes: 23 additions & 20 deletions docs/en/notes/tools.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,48 @@
# Tools
Possible tools that may be used.
Tools that may come in handy

## Third-party Tools
Includes software, websites, etc.
Including software, websites, etc.

- [MapShaper](https://mapshaper.org/) Map editor. It can edit `.geojson` files and export them as `.shp` files.
- [Three.js Editor](https://threejs.org/editor/) Online 3D object editor for Three.js.

## External Functions
Some external functions for MicroCity Web.
Some external functions for MicroCity Web

### How to Use
### Instructions

It is recommended to import functions online to ensure that the latest version is used. You can also choose to download them locally and then upload for use.
It is recommended to import functions online to ensure the use of the latest version of functions. You can also choose to download them locally and then upload for use.

Example of online import
Online import example
```lua
print('Downloading dependent libraries to virtual disk...')
os.upload('https://www.zhhuu.top/ModelResource/libs/file.lua')
print('Download completed')
print('Downloading dependency library to virtual disk...')
os.upload('https://www.zhhuu.top/ModelResource/libs/file_name.lua')
print('Download complete')
```

#### Importing Functions
#### Importing functions

If the function file name is `abc.lua`, you can import the function by using `require("abc")`.
If the function file name is `abc.lua`, importing the function completes the process.
```lua:no-line-numbers
require("abc")
```

### Function List

Mostly homemade functions.

Since the files are hosted on GitHub Pages, importing them online may be slow. You can choose to download them locally and then upload for use.

The list of code files provided by this site can be found in [ModelResource/libs](https://github.com/huuhghhgyg/ModelResource/tree/main/libs). The following list consists of files from the ModelResource repository.
Since the files are all hosted on GitHub Pages, online importing might be slower. You can opt to download them locally and then upload for use.

| Name | Description | Link |
| ----------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Histogram | Used to draw a histogram | [ModelResource/libs/Histogram.lua](https://github.com/huuhghhgyg/ModelResource/blob/main/libs/Histogram.lua) |
| Subplot | Used to draw subplots | [ModelResource/libs/Subplot.lua](https://github.com/huuhghhgyg/ModelResource/blob/main/libs/Subplot.lua) |
| TableString | Converts table to a string | [ModelResource/libs/TableString.lua](https://github.com/huuhghhgyg/ModelResource/blob/main/libs/TableString.lua) |
The list of code files provided on this site is shown in [ModelResource/libs](https://github.com/huuhghhgyg/ModelResource/tree/main/libs), and the list below are all files from the ModelResource repository.

| Name | Description | Link |
| --------- | -------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Histogram | Used to draw histograms | [ModelResource/libs/Histogram.lua](https://github.com/huuhghgyg/ModelResource/blob/main/libs/Histogram.lua) |
| Subplot | Draw subplots when drawing multiple graphs | [ModelResource/libs/Subplot.lua](https://github.com/huuhghgyg/ModelResource/blob/main/libs/Subplot.lua) |
| tablestr | Convert table to string | [ModelResource/libs/tablestr.lua](https://github.com/huuhghgyg/ModelResource/blob/main/libs/tablestr.lua) |
| setpoint | Set display points at specified coordinates | [ModelResource/libs/setpoint.lua](https://github.com/huuhghgyg/ModelResource/blob/main/libs/setpoint.lua) |

🔨 Continuous updates...
🔨 Continuously updating...

> This post is translated using ChatGPT, please [**feedback**](https://github.com/huuhghhgyg/MicroCityNotes/issues/new) if any omissions.
50 changes: 24 additions & 26 deletions docs/en/notes/versions.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,44 @@
# Versions of MicroCity
# Version Information of MicroCity

MicroCity is a simple and fast spatial planning and modeling software, which can be used for mathematical model construction, solving, and simulation experiments, especially suitable for the field of digital modeling in logistics. Initially, MicroCity was only available as a Desktop version that could only run on the Windows operating system. Later, there was a demand for cross-platform use, so MicroCity Web version was introduced, which can run well on browsers with the Chromium kernel.

## MicroCity
![GitHub release (latest by date)](https://img.shields.io/github/v/release/microcity/Desktop) [![GitHub release (by tag)](https://img.shields.io/github/downloads/microcity/Desktop/latest/total)](https://github.com/microcity/Desktop/releases/latest)

When MicroCity software was initially launched, there was only a desktop version available, which could only run on Windows operating systems. Over time, the developer ([@mixwind](https://github.com/sunzhuo)) realized that this limitation prevented many potential users from using the software because they might be using other operating systems such as MacOS, Linux, and others.

## MicroCityWeb
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/microcity/microcity.github.io/master)

🎯[Visit MicroCity Web](https://microcityweb.gitee.io) 📍[(Offline version) Download](https://gitee.com/microcityweb/microcityweb/releases/latest)
🎯[Visit MicroCity Web](https://microcityweb.gitee.io) 📍[Download (Offline Version)](https://gitee.com/microcityweb/microcityweb/releases/latest)

To address this issue, the developer decided to develop MicroCityWeb, which is a version that can be directly run in a web browser. MicroCityWeb does not require any installation, just access its website using a modern browser such as Google Chrome or Microsoft Edge. Although running in a browser may cause some performance loss compared to the desktop version, it allows users to use the software on almost any operating system, such as Windows, MacOS, Linux for computers, and Android for mobile devices and tablets.
MicroCity Web does not require any installation, just use a modern browser (such as Google Chrome, Microsoft Edge) to access its website. Although running on a browser may cause some performance loss compared to the desktop version, it allows users to use the software on almost any operating system, such as computer systems Windows, MacOS, Linux, and mobile/tablet systems Android, etc.

Although MicroCityWeb has been developed by the creators of MicroCity, you can still continue to use the previously developed desktop version of MicroCity. However, the desktop version will no longer receive updates for new features. All new features and improvements will be focused on the MicroCityWeb version. This decision aims to ensure that MicroCity can focus on one version and provide the best possible experience in that version. It also makes it easier to manage and maintain MicroCity, avoiding version control issues.
Even with the release of MicroCity Web, you can still continue to use the previously developed Desktop version of MicroCity. However, the desktop version will no longer be updated with new features, all new functions and improvements will be delivered continuously to MicroCity Web, in order to provide the best user experience and avoid version control issues. If you want to experience the latest features and improvements, it is necessary to switch to MicroCity Web.

It should be noted that although the desktop version will no longer receive updates for new features, it can still be used. If users are already accustomed to using the desktop version, they can continue to do so. However, if users want to experience the latest features and improvements, they will need to switch to the MicroCityWeb version.
The MicroCity Web version also provides an offline version bundled for export using the browser (see above 🔗[link](#microcityweb)).

The MicroCityWeb version also provides an offline version packaged for browsers (see link above 🔗[link](#microcityweb)).

::: warning
However, due to updates to the Chromium browser engine, certain outdated system versions may not be supported (such as Windows versions 8.1 and below, 32-bit Windows operating systems, etc.).
:::
> [!warning]
> However, due to updates in the Chromium browser kernel, some older system versions may not be supported (such as Windows versions below 8.1, 32-bit Windows operating systems, etc.)
## Compatibility
Due to the use of experimental JavaScript functions, MicroCityWeb may have compatibility issues running on the following browser engines:
* Most browsers on iOS and iPadOS (due to Apple's requirement to use Safari's browser engine)
* Firefox browser
MicroCity Web version uses Lua 5.4 as the scripting language. You can enter the command `print(_VERSION)` in the MicroCity Web runtime environment or editor to view the Lua version used.

Due to the use of experimental JavaScript functions, there may be compatibility issues when running MicroCity Web in the following browser kernels:
* Browsers with Safari kernel, such as most browsers on iOS, iPad OS (due to Apple's mandatory use of Safari browser kernel), Safari browser on MacOS
* FireFox browser

**Compatibility issues and some technical details encountered during testing on 29th September 2023**
* iOS and iPadOS:
**Compatibility issues encountered during testing on 2023/9/29 and some technical details:**
* iOS and iPad OS:
* Unable to open local files (due to the use of `showOpenFilePicker()` method)
* Firefox:
* FireFox:
* Unable to open local files (due to the use of `showOpenFilePicker()` method)

Regarding the impact of the `showOpenFilePicker()` method, please refer to [MDN Web Docs | showOpenFilePicker()](https://developer.mozilla.org/zh-CN/docs/Web/API/window/showOpenFilePicker#%E6%B5%8F%E8%A7%88%E5%99%A8%E5%85%BC%E5%AE%B9%E6%80%A7).

## Summary
The launch of MicroCityWeb version makes the software more user-friendly and popular, benefiting a wider range of users. At the same time, the MicroCity desktop version is still available, allowing users who are accustomed to this version to continue using it and facilitating their transition to the MicroCityWeb version.
## Additional Information
For the impact of the `showOpenFilePicker()` method, please refer to [MDN Web Docs | showOpenFilePicker()](https://developer.mozilla.org/zh-CN/docs/Web/API/window/showOpenFilePicker#%E6%B5%8F%E8%A7%88%E5%99%A8%E5%85%BC%E5%AE%B9%E6%80%A7).

At the time of writing this note, the MicroCityWeb is being used for the first time in a teaching environment and is able to function properly and provide certain simulation capabilities. The author's learning experience with MicroCity is as follows:
* MicroCity (desktop version): Logistics information management
* MicroCityWeb: Logistics system simulation
The author of this note was in the process of writing when MicroCity Web was being used for the first time in an educational environment. It can now operate properly and simulate certain functions. The author's relevant learning experiences are as follows:
* MicroCity Desktop: Logistics Information Management
* MicroCity Web: Logistics System Simulation

The content of this note is for reference only. If there are any discrepancies in the content due to time factors, you are also welcome to make corrections to the content of this note on Github through a Pull Request 🥳. Please check the [Pull Request](https://github.com/huuhghhgyg/MicroCityNotes/pulls) for further details.
The content of this note is for reference only. If there are any deviations in the content due to the passage of time, corrections to the content of this site are welcome via [Pull Request](https://github.com/huuhghhgyg/MicroCityNotes/pulls) on GitHub 🥳.

> This post is translated using ChatGPT, please [**feedback**](https://github.com/huuhghhgyg/MicroCityNotes/issues/new) if any omissions.
2 changes: 1 addition & 1 deletion docs/notes/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ print('下载完成')
#### 导入函数

如果函数文件名为 `abc.lua`,引用函数后即完成导入。
```lua
```lua:no-line-numbers
require("abc")
```

Expand Down

0 comments on commit 692098b

Please sign in to comment.