mirror of
https://github.com/yu-i-i/overleaf-cep.git
synced 2026-11-12 13:13:45 +01:00
Release v6.2.0-ext-v5.1
@@ -16,9 +16,9 @@ the following variables has been added in Extended CE:
|
||||
```javascript
|
||||
db.projects.updateMany({}, { $set: { "overleaf.history.rangesSupportEnabled": true } });
|
||||
```
|
||||
- ~~`OVERLEAF_THEMED_DASHBOARD`~~
|
||||
* ~~If set to `true`, experimental themed support for project list and admin tools dashboards is enabled~~ (removed in `6.2.0-ext-v5.0`)
|
||||
- `ENABLE_EDITOR_TABS`
|
||||
* If set to `true`, enables the experimental upstream editor tabs feature
|
||||
- `ENABLE_PANDOC_CONVERSIONS`
|
||||
* If set to `true`, enables the experimental upstream Pandoc conversion features. See [Pandoc Conversions](Extended-CE:-Pandoc-Conversions) for details
|
||||
- ~~`OVERLEAF_THEMED_DASHBOARD`~~
|
||||
* ~~If set to `true`, experimental themed support for project list and admin tools dashboards is enabled~~ (removed in `6.2.0-ext-v5.0`)
|
||||
- ~~`ENABLE_EDITOR_TABS`~~
|
||||
* ~~If set to `true`, enables the experimental upstream editor tabs feature~~ (removed in `6.3.0-ext-v5.1`, enabled by default)
|
||||
|
||||
@@ -11,22 +11,23 @@ services:
|
||||
```
|
||||
If you use the `git-bridge` image, update the version number in `overleaf-toolkit/config/version` to match the upstream version, for example:
|
||||
```
|
||||
6.2.0
|
||||
6.3.0
|
||||
```
|
||||
If you want to build a Docker image of the extended CE based on the upstream `v6.2.0` release, first check out the tag corresponding to `v6.2.0-ext-v5.0`:
|
||||
If you want to build a Docker image of the extended CE based on the upstream `v6.3.0` release, first check out the tag corresponding to `v6.3.0-ext-v5.1`:
|
||||
```
|
||||
git checkout v6.2.0-ext-v5.0
|
||||
git checkout v6.3.0-ext-v5.1
|
||||
```
|
||||
After building this image, switch to the the branch `ext-ce-v6.2`, rewiev the `server-ce/hotfix` directory, and build the patched images sequentially: v6.2.0-ext-v5.0, ..., v6.2.n-ext-v5.0.
|
||||
After building this image, switch to the the branch `ext-ce-v6.3`, rewiev the `server-ce/hotfix` directory, and build the patched images sequentially: 6.3.0-ext-v5.1, ..., 6.3.n-ext-v5.1.
|
||||
|
||||
Alternatively, you can download a prebuilt image from Docker Hub:
|
||||
```
|
||||
docker pull overleafcep/sharelatex:6.2.0-ext-v5.0
|
||||
docker pull overleafcep/sharelatex:6.3.0-ext-v5.1
|
||||
```
|
||||
Make sure to update the image name in `overleaf-toolkit/config/docker-compose.override.yml` accordingly.
|
||||
|
||||
Notes for updating 5.5.x-ext images:
|
||||
<details>
|
||||
<summary>Notes for updating 5.5.x-ext</summary>
|
||||
|
||||
- When updating from v5.5.2-ext-v3.2 to v5.5.3-ext-v3.2, remove [this line](https://github.com/yu-i-i/overleaf-cep/blob/1822cfc1b65dfb0ba4392e1ae4764d0999f4ec1f/server-ce/hotfix/5.5.3/Dockerfile#L16) from `server-ce/hotfix/5.5.3/Dockerfile`
|
||||
- v5.5.6-ext-v3.3 should be build on top of v5.5.6-ext-v3.2, using the hotfix directory: `server-ce/hotfix/5.5.6-ext-3.3`
|
||||
|
||||
- 5.5.6-ext-v3.3 should be build on top of 5.5.6-ext-v3.2, using the hotfix directory: `server-ce/hotfix/5.5.6-ext-3.3`
|
||||
</details>
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
## Python Script Runner
|
||||
|
||||
The Python Script Runner lets you write and run Python scripts directly in your Overleaf project.
|
||||
Any files your script generates — figures, CSVs, or other outputs — are saved to the file tree and are available to use in your LaTeX document.
|
||||
|
||||
<div align="center">
|
||||
<img src="images/Python-Runner.png"
|
||||
width="600"
|
||||
>
|
||||
<br>
|
||||
<em>Python Script Runner</em>
|
||||
</div>
|
||||
<br>
|
||||
|
||||
### Activate the Python Script Runner
|
||||
|
||||
To use the Python Script Runner, open any `.py` file from your project's file tree. The editor switches to Python mode and a **Run** button appears.
|
||||
|
||||
If your project doesn't have a `.py` file yet, create one using the **New file** button in the file tree.
|
||||
|
||||
### Write and run a script
|
||||
|
||||
1. Open a `.py` file from the file tree.
|
||||
2. Write your Python code in the editor.
|
||||
3. Select **Run** to execute the script.
|
||||
|
||||
To stop a script while it's running, select **Stop**.
|
||||
|
||||
### Understand the output panel
|
||||
|
||||
When you run a script, the output panel opens below the editor. It shows:
|
||||
|
||||
- **Standard output:** text printed by your script, such as the result of `print()` statements
|
||||
- **Errors:** if your script fails, the output panel shows what went wrong. There are two types:
|
||||
|
||||
- **Environment errors:** for example, a package that isn't available in the runner. Check the list of [supported packages](https://pyodide.org/en/stable/usage/packages-in-pyodide.html) before importing.
|
||||
- **Code errors:** syntax mistakes or runtime errors in your script, such as a `NameError` or `TypeError`
|
||||
|
||||
### Use files from the file tree as inputs
|
||||
|
||||
Your script can read files already in your project — for example, a `.csv` you've uploaded:
|
||||
|
||||
```py
|
||||
import csv
|
||||
with open("data.csv") as f:
|
||||
reader = csv.reader(f)
|
||||
for row in reader:
|
||||
print(row)
|
||||
```
|
||||
|
||||
### Save output files to the file tree
|
||||
|
||||
Any files your script writes are saved to the project file tree automatically. For example, a figure saved with `plt.savefig("output.png")`
|
||||
will appear in the file tree and can be included in your LaTeX document using `\includegraphics{output.png}`.
|
||||
|
||||
### Supported packages and Python version
|
||||
|
||||
The Python Script Runner uses [Pyodide](https://pyodide.org/en/stable/usage/packages-in-pyodide.html) 0.29.3, which runs Python 3.13.2.
|
||||
A full list of supported packages is available on the [Pyodide packages page](https://pyodide.org/en/stable/usage/packages-in-pyodide.html).
|
||||
|
||||
## Known limitations
|
||||
|
||||
- Scripts run in your browser using your local system resources. Large or computationally expensive scripts may be slow or cause the tab to become unresponsive.
|
||||
- Only packages available in Pyodide are supported. Packages that require native code or are not in the Pyodide distribution cannot be installed.
|
||||
+9
@@ -11,6 +11,15 @@ the [Overleaf Wiki Page](https://github.com/overleaf/overleaf/wiki).
|
||||
|
||||
## Overleaf CE+ Release Notes
|
||||
|
||||
<h3><code>v6.3.0-ext-v5.1</code></h3>
|
||||
|
||||
- Based on upstream release v6.3.0
|
||||
- Added [Python script runner](Extended-CE%3A-Python-Runner) module
|
||||
- Added the ability to count words in a selected text
|
||||
- Modals now follow the theme (dark or light)
|
||||
- Removed the `ENABLE_EDITOR_TABS` environment variable (the editor tabs feature is still experimental upstream, but works reliably and is now always enabled)
|
||||
- Various bug fixes
|
||||
|
||||
<h3><code>v6.2.0-ext-v5.0</code></h3>
|
||||
|
||||
- Based on upstream release v6.2.0
|
||||
|
||||
+1
@@ -12,5 +12,6 @@
|
||||
- [From External URL Feature](Extended-CE%3A-From-External-URL)
|
||||
- [Pandoc Conversion](Extended-CE%3A-Pandoc-Conversion)
|
||||
- [Sign Up Page](Extended-CE%3A-Sign-Up-Page)
|
||||
- [Python Script Runner](Extended-CE%3A-Python-Runner)
|
||||
- [Environment Variables](Extended-CE%3A-Environment-Variables)
|
||||
- [Useful Links](Extended-CE%3A-Useful-Links)
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 240 KiB |
Reference in New Issue
Block a user