# Soulver X Series ## What is the Soulver X Series? In 2024, we embarked on a multi-year R\&D project whose mission is to: * Explore cool new ideas for Soulver * Seek out new forms & new workflows * Boldly go where no notepad calculator has gone before 🖖 We intend to release a major new X series version every year. ### Soulver X Series Sponsorship If you're a long time user (or Soulver mega-fan), and are excited by this work, you might consider [sponsoring our mission on GitHub](https://soulver.app/sponsor). Also, as a sponsor, you'll get access to the latest X series prototype (X3, X4, etc) with more never-before-seen features in the notepad calculator domain. Our (very) small team would appreciate the support, and we'll be able to dedicate more resources to this kind of advanced notepad calculator R\&D. ## Soulver X2 (2025) ### Subsheets * A subsheet is a separate sheet that lives inside a single token. * Create a subsheet from the + button in the tab bar. * Double-click the purple token to open the subsheet editor. * Subsheets can reference variables from the mother sheet (provided the variables are declared above the subsheet's line). ### Slider Tokens with Ranges * A slider token allows you to specify the range for a scrubbable slider * Create a slider from the + button in the tab bar. * Double-click the green token to open the slider popup. ### Divider Lines * Type dash (-) three times to insert a divider line. * Use divider lines to create more visual separation between different parts of your sheet. ## Soulver X1 (2024) X1 includes implementations of Soulver's top feature requests, including: * [Custom function support](https://soulver.app/feedback) (*including* *natural language functions)* * [Sharing variables across sheets](https://soulver.app/feedback) (*via the new "header" sheet)* * [Connecting to Web APIs](https://soulver.app/feedback) (*with just a paste and a couple of clicks)* ### Tabs

Documents in Soulver X1 start with a single tab, and you can add more by clicking the + button in the right of the tab bar. **Renaming tabs** Double click on the title of a tab to give it an alternative name. Alternatively, control-click on the tab and choose "Rename". **Deleting tabs** When you hover over a tab, click the x button to delete. Alternatively, control-click on the tab and choose "Delete" {% hint style="warning" %} Tabs are a work in progress feature. You cannot rearrange tabs (yet), and adding too many tabs in a single document does not work correctly. {% endhint %} ### The header sheet The header is a dedicated sheet for defining variables, units, functions, and web values that can be used across all tabs in your document.

### **Cross-tab variables** Declare variables for your document in the header the same way you would declare local variables. For example: ``` my variable = 123 ``` `my variable` will be available across all your sheets {% hint style="info" %} Your tabs can only reference variables, but cannot modify their definition such that it will apply to other sheets in the document. {% endhint %} ### **Equivalence units** An equivalence unit is defined in terms of an existing unit. Define a new equivalence unit in the header using (for example): ``` 1 watermelon = 10 lb ```

Declaring a new unit of mass in Soulver X1

The `watermelon` can now be used as a unit of mass across your tabs.

Using a custom equivalence unit in Soulver X1

{% hint style="info" %} Soulver X1 automatically pluralises your new unit for you (in English). So in this example, both "watermelons" will be recognized as a valid unit name, even though the definition was "watermelon". {% endhint %} ### **Generic units** An equivalence unit is an entirely new unit type, not defined in terms of an existing unit. Define a new generic unit in the header using (for example): ``` operation = new unit ```

Declaring a generic unit type in Soulver X1

The `operation` unit can now be used across your tabs (including in rates):

### **Custom functions** **Introduction** A function is a handy phrase that takes an input and returns an output. In Soulver X1, you can use (almost) any syntax for a function, including: C-style: `doSomething(123)` Swift-style: `doSomething(with: 123)` Natural language: `do something with 123` **To create a new custom function (in the header)** * Click `Define New` > `Function` **Choosing a function name:**

* Define your function using an example of how you might use the function in practice. * Choose any parameters (so long as they match the "type" of parameter that you expect for your implementation, like money, time, plain decimal numbers, etc). **Implementing your function:**

Writing a function to calculate how much sales tax there is in a certain amount

* Implement the function in a dedicated Soulver sheet. Any parameters will be injected as yellow tokens. * Hover over a parameter token to see what parameter it refers to in the declaration. * The last line of the implementation sheet will be returned as the function's final value. **Using your function**

Use your function with other input values across all of your sheets ### **Web values (connecting to JSON APIs)** #### **To create a new web value (in the header)** * Click `Define New` > `Web Value` #### **To connect to a particular data point in a JSON data feed**

Connecting to a remote data feed in Soulver X1

* Paste in a URL to a JSON data feed, and then simply click on the data point you wish to connect to #### **Using a web value** * Your web value will be assigned a variable name (by default, matching its description in the JSON feed) * You're welcome to change the variable name to something else #### **Updating a web value** * Your web value will be automatically updated in the background with the frequency that you specified during setup #### **Editing a web value** * Double-click the yellow web value token in the header to specify a different data point, or change the update frequency ## Soulver X Series File Type {% hint style="warning" %} Soulver X series apps use a different document type (.slvrx) from Soulver. This is to support the new features we're building and experimenting with. Soulver X (.slvrx) files cannot be edited by Soulver 3 for Mac, iOS & iPad. {% endhint %}