diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index b7cd193..a7b9a69 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -1938,25 +1938,25 @@ export default defineConfig({ ], }, { - text: "Uncatogorized", + text: "Uncategorized", collapsed: true, - link: "/functions/uncatogorized", + link: "/functions/uncategorized", items: [ { text: "REGEXTEST", - link: "/functions/uncatogorized/regextest", + link: "/functions/uncategorized/regextest", }, { text: "REGEXEXTRACT", - link: "/functions/uncatogorized/regexextract", + link: "/functions/uncategorized/regexextract", }, { text: "REGEXREPLACE:", - link: "/functions/uncatogorized/regexreplace:", + link: "/functions/uncategorized/regexreplace:", }, { text: "TRIMRANGE", - link: "/functions/uncatogorized/trimrange", + link: "/functions/uncategorized/trimrange", }, ], }, diff --git a/docs/src/functions/cube/cubekpimember.md b/docs/src/functions/cube/cubekpimember.md index 32cd83c..67dbff5 100644 --- a/docs/src/functions/cube/cubekpimember.md +++ b/docs/src/functions/cube/cubekpimember.md @@ -4,23 +4,9 @@ outline: deep lang: en-US --- -::: warning -**Note:** This function is not yet available in IronCalc 🚧 -[Follow development here](https://github.com/ironcalc/IronCalc/labels/Functions) -::: - -::: warning -**Note:** This page is under construction 🚧 -::: - # CUBEKPIMEMBER -## Parameters - -## Overview - -## Examples - -[See this example in IronCalc](https://app.ironcalc.com/?filename=cubekpimember) - -## Links \ No newline at end of file +::: warning +🚧 This function is not yet available in IronCalc. +[Follow development here](https://github.com/ironcalc/IronCalc/labels/Functions) +::: diff --git a/docs/src/functions/financial/fv.md b/docs/src/functions/financial/fv.md index 85d836c..f1132e6 100644 --- a/docs/src/functions/financial/fv.md +++ b/docs/src/functions/financial/fv.md @@ -26,7 +26,7 @@ If your interest rate varies between periods, use the **FVSCHEDULE** function in ### Additional notes -- FV may generate #ERROR!, #VALUE! or #DIV/0! errors. For more details see our Error Types page (link when page written). +- FV may generate #ERROR!, #VALUE! or #DIV/0! errors. For more details see our [Error Types page](/features/error-types.md). - Make sure that the _rate_ argument specifies the interest rate or yield applicable to the compounding period, based on the value chosen for _nper_. - The _pmt_ and _pv_ arguments should be expressed in the same currency unit. FV returns a value in the same currency unit. - To ensure a worthwhile result, one of the _pmt_ and _pv_ arguments should be set to a non-zero value. diff --git a/docs/src/functions/lookup_and_reference/address.md b/docs/src/functions/lookup_and_reference/address.md index f80c32f..e01e54a 100644 --- a/docs/src/functions/lookup_and_reference/address.md +++ b/docs/src/functions/lookup_and_reference/address.md @@ -4,18 +4,8 @@ outline: deep lang: en-US --- -::: warning -**Note:** This page is under construction 🚧 -::: - # ADDRESS -## Parameters - -## Overview - -## Examples - -[See this example in IronCalc](https://app.ironcalc.com/?filename=address) - -## Links \ No newline at end of file +::: warning +🚧 This function is implemented but currently lacks detailed documentation. For guidance, you may refer to the equivalent functionality in [Microsoft Excel documentation](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb). +::: diff --git a/docs/src/tironcalc/about.md b/docs/src/tironcalc/about.md index c3e9c1b..48c0e64 100644 --- a/docs/src/tironcalc/about.md +++ b/docs/src/tironcalc/about.md @@ -9,3 +9,14 @@ lang: en-US ::: warning **Note:** This page is in construction 🚧 ::: + +# About TironCalc + +**TironCalc**, or **Tiron** for friends, is a TUI (Terminal User Interface) for **IronCalc**. It’s designed to bring the functionality of IronCalc to the command line, using the [**ratatui**](https://github.com/ratatui-org/ratatui) library. + +## Inspiration + +TironCalc is inspired by earlier terminal-based spreadsheet tools: + +- James Gosling of Java fame created [sc]() the spreadsheet calculator. +- Andrés Martinelli has been maintaining [sc-im](https://github.com/andmarti1424/sc-im), the spreadsheet calculator improvised. diff --git a/docs/src/tironcalc/installing.md b/docs/src/tironcalc/installing.md index 6fa3872..793a77e 100644 --- a/docs/src/tironcalc/installing.md +++ b/docs/src/tironcalc/installing.md @@ -6,6 +6,32 @@ lang: en-US # Installing and running Tironcalc -::: warning -**Note:** This page is in construction 🚧 -::: +## Build + +``` +cargo build --release +``` + +You will find the binary at `./target/release/tiron`. + +## Documentation + +Start empty project: + +``` +$ tiron +``` + +Load an existing Excel file: + +``` +$ tiron example.xlsx +``` + +- `Arrow Keys` to navigate cells +- `e` to edit a cell and enter the value or formula. +- `q` to quit and save +- `+` to add a sheet +- `s` to go to the next sheet +- `a` to go to the previous sheet +- `PgUp/PgDown` to navigate rows faster diff --git a/docs/src/web-application/about.md b/docs/src/web-application/about.md index 470be2b..9e26c6c 100644 --- a/docs/src/web-application/about.md +++ b/docs/src/web-application/about.md @@ -4,8 +4,19 @@ outline: deep lang: en-US --- -# Importing Files +# About the Web Application -::: warning -**Note:** This page is in construction 🚧 -::: +The IronCalc web application serves multiple purposes: + +- **Showcasing Capabilities**: It provides a visual demonstration of what IronCalc can do, highlighting its core features and performance. + +- **Testing Features**: Users can experiment with various functionalities, making it a useful tool for exploring IronCalc's potential. + +- **A Practical Alternative**: Beyond testing, the web app is designed to function as a lightweight alternative to traditional spreadsheet systems. + +IronCalc is a **work in progress** project, meaning it is constantly evolving. New features and improvements are regularly added to enhance your experience. + +To stay updated: + +- Check out our [Changelog](https://github.com/ironcalc/IronCalc/releases) for the latest updates. +- Follow us on [Discord](https://discord.gg/zZYWfh3RHJ) or [social media](https://bsky.app/profile/ironcalc.com) for announcements and sneak peeks at upcoming features. diff --git a/docs/src/web-application/sharing-files.md b/docs/src/web-application/sharing-files.md index 8752563..e987247 100644 --- a/docs/src/web-application/sharing-files.md +++ b/docs/src/web-application/sharing-files.md @@ -6,6 +6,32 @@ lang: en-US # Sharing Files -::: warning -**Note:** This page is in construction 🚧 -::: \ No newline at end of file +IronCalc makes it easy to share your files with others. Follow these steps to share a sheet and understand how sharing works. + +## How to Share a File + +1. **Click the Share Button**: + In the web app, click the **"Share"** button located in the top-right corner of the interface. + +2. **Copy the URL**: + Upon clicking, the sharing URL will be automatically copied to your clipboard. + +3. **Share the URL**: + Paste the URL into a message, email, or browser to share it or open the sheet. + +## How Sharing Works + +- **Snapshot of the Original Sheet**: + When the URL is used to open the sheet, it displays the version of the sheet that was visible when the **"Share"** button was clicked. Please note that **any changes made to the original sheet after sharing will not be reflected in the shared version**. + +- **Changes in the Shared Version**: + Any modifications made in the shared sheet (even if it’s an existing sheet) will **not** overwrite or affect the original sheet. + +## Managing Sheets + +All your created sheets can be accessed from the **"File"** section in the top-left corner of the window. From here, you can: + +- View all existing sheets. +- Delete sheets as needed. + +This helps you keep your files organized and makes sharing simple and straightforward.