You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Summary
- Rewrite README to match current File/Edit/Plugins menu structure
- Add keyboard shortcuts table and menu reference
- Document bundled plugins (XML Viewer, Clip Inspector) and plugin
authoring
- Bump MinVer to v2.0 across all projects (SharpFM, Plugin,
Plugin.Sample, Plugin.XmlViewer)
- Add `Version` property to `IPanelPlugin` interface, shown in Plugin
Manager UI
- Fix asset path for project restructure
## Test plan
- [x] `dotnet build && dotnet test` passes (198 tests)
- [x] Plugin Manager shows version for each loaded plugin
- [x] README accurately reflects current menu layout and workflows
SharpFM is a cross-platform (Mac, Windows, Linux) FileMaker Pro Developer Utility to help when migrating FileMaker code between FileMaker files, sharing FileMaker code with other developers, or simply see what's happening under the hood. This means you can copy scripts, layouts, tables, etc (anything you can copy/paste in FileMaker) across machine barriers like Remote Desktop, Citrix/XenApp or anything that can copy plain text between machines, save them for later, change them if you want, then finally re-paste them into the same or other FileMaker file.
3
+
SharpFM is a cross-platform (Mac, Windows, Linux) FileMaker Pro Developer Utility for migrating FileMaker code between files, sharing code with other developers, or inspecting what's happening under the hood. Copy scripts, layouts, tables, and fields from FileMaker Pro, edit them in structured editors, and paste them back -- across machine barriers like Remote Desktop, Citrix, or anything that supports plain text.
4
4
5
5
## Getting Started
6
6
7
-
Note: SharpFM and FileMaker must be running on the same computer. In order to share or move a clip across machine barriers, you must share the text based XML version.
7
+
Head over to [Releases](https://github.com/fuzzzerd/SharpFM/releases) and grab the latest version for your platform (Windows, Mac, Linux).
8
8
9
-
- Head over to [Releases](https://github.com/fuzzzerd/SharpFM/releases), grab the latest version (binaries for Windows, Mac, Linux are all available there).
9
+
SharpFM and FileMaker must be running on the same computer. To share clips across machines, use the XML files directly.
10
10
11
11
### Importing Clips from FileMaker
12
12
13
-
- Open SharpFM.
14
-
- Switch over to FileMaker.
15
-
- Copy something to the clipboard (scripts, tables, layouts, etc).
16
-
- Switch back to SharpFM.
17
-
- Use **File > New > From Clipboard** (`Ctrl+V`) to import the clip.
18
-
- The clip appears in the left panel with the appropriate editor on the right.
13
+
1. Open SharpFM and FileMaker side by side.
14
+
2. In FileMaker, copy something to the clipboard (scripts, tables, layouts, etc).
15
+
3. In SharpFM, use **Edit > Paste from FileMaker** (`Ctrl+V`).
16
+
4. The clip appears in the left panel with the appropriate editor on the right.
19
17
20
18
### Exporting Clips to FileMaker
21
19
22
-
- Select a clip in the left panel.
23
-
- Use **File > Save > Selected clip to Clipboard** (`Ctrl+Shift+C`).
24
-
- Switch to FileMaker and open the appropriate destination (Database Manager, Script Workspace, Layout mode, etc).
25
-
- Paste as you normally would.
20
+
1. Select a clip in the left panel.
21
+
2. Use **Edit > Copy to FileMaker** (`Ctrl+Shift+C`).
22
+
3. Switch to FileMaker and open the appropriate destination (Database Manager, Script Workspace, Layout mode, etc).
23
+
4. Paste as you normally would.
24
+
25
+
### Creating New Clips
26
+
27
+
-**File > New Script** (`Ctrl+N`) -- creates an empty script clip with the FmScript editor.
28
+
-**File > New Table** (`Ctrl+Shift+N`) -- creates an empty table clip with the DataGrid editor.
26
29
27
30
### Editing Scripts
28
31
29
-
- Select a script clip or create one with **File > New > Script** (`Ctrl+N`).
30
-
- The script editor shows a plain-text representation of the script steps with FmScript syntax highlighting.
31
-
- Edit the script text directly; changes are synced back to the underlying XML.
32
+
Select a script clip to open the plain-text script editor with FmScript syntax highlighting, autocomplete, bracket matching, and validation diagnostics. Edit the script text directly -- changes sync to the underlying XML automatically.
32
33
33
34
### Editing Tables
34
35
35
-
- Select a table clip or create one with **File > New > Table** (`Ctrl+Shift+N`).
36
-
- The table editor shows a DataGrid with columns for Field Name, Type, Kind, Required, Unique, and Comment.
37
-
- Click **+ Add Field** to add a new field, then edit its properties inline.
38
-
- Select a field and click **Remove** or press `Delete` to remove it.
39
-
- Change a field's Kind to Calculated or Summary, then click **Edit Calculation...** to open the calculation editor.
36
+
Select a table clip to open the DataGrid editor with columns for Field Name, Type, Kind, Required, Unique, and Comment. Use **+ Add Field** to add fields, **Remove** or `Delete` to remove them. Change a field's Kind to Calculated or Summary, then click **Edit Calculation...** for the calculation editor.
40
37
41
38
### Viewing Raw XML
42
39
43
-
- Select any clip and use **View > Show XML** (`Ctrl+Shift+X`) to open the raw XML in a separate window.
44
-
- Edits made in the XML window are synced back to the clip when the window is closed.
40
+
Use the **XML Viewer** plugin (`Ctrl+Shift+X`) to open a live XML panel alongside any structured editor. Edits in either direction sync automatically -- change the script and the XML updates, edit the XML and the script rebuilds.
41
+
42
+
### Saving and Loading Clips
43
+
44
+
SharpFM persists clips as XML files in a local folder.
45
45
46
-
### Saving and Sharing Clips
46
+
-**File > Save All** (`Ctrl+S`) -- saves all clips to the current folder.
47
+
-**File > Open Folder...** -- load clips from a different folder.
48
+
- Clip files are plain XML and can be shared via git, email, or any text-based tool.
47
49
48
-
SharpFM persists clips between sessions as XML files in a local folder.
50
+
## Keyboard Shortcuts
49
51
50
-
- Use **File > Save > Save All To Folder** (`Ctrl+S`) to save all clips.
51
-
- Use **File > Open Folder** to load clips from a different folder.
52
-
- The clip files are plain XML and can be shared via git, email, or any text-based tool.
52
+
| Shortcut | Action |
53
+
|----------|--------|
54
+
|`Ctrl+N`| New Script |
55
+
|`Ctrl+Shift+N`| New Table |
56
+
|`Ctrl+V`| Paste from FileMaker |
57
+
|`Ctrl+Shift+C`| Copy to FileMaker |
58
+
|`Ctrl+S`| Save All |
59
+
|`Ctrl+Shift+X`| Toggle XML Viewer |
60
+
61
+
## Menu Reference
62
+
63
+
| Menu | Items |
64
+
|------|-------|
65
+
|**File**| New Script, New Table, Open Folder..., Save All, Exit |
66
+
|**Edit**| Paste from FileMaker, Copy to FileMaker, Copy as C# Class |
-[x] Copy FileMaker Scripts, Tables, or Layouts From FileMaker Pro to their XML representation and back into FileMaker.
57
-
-[x] Store FileMaker Scripts, Tables, and Layouts to xml files that can be shared via git, email or other text based tools.
58
-
-[x] Edit raw FileMaker XML code (scripts, layouts, tables) with ability to paste changes back into FileMaker.
59
-
-[x] Use AvaloniaEdit for XML editing with XML syntax highlighting.
60
-
-[x] Plain-text script editor with FmScript syntax highlighting.
61
-
-[x] DataGrid table/field editor with inline editing, calculation editor, and type/kind selection.
62
-
-[x] View and edit raw XML alongside structured editors.
71
+
- Copy FileMaker Scripts, Tables, Fields, and Layouts to their XML representation and back.
72
+
- Persist clips as XML files shareable via git, email, or other text-based tools.
73
+
- Plain-text script editor with FmScript syntax highlighting, autocomplete, and validation.
74
+
- DataGrid table/field editor with inline editing, calculation editor, and type/kind selection.
75
+
- Live bidirectional XML viewer -- edit XML or structured data, both stay in sync.
76
+
- Extensible plugin architecture for adding custom panels and tools.
63
77
64
78
## Plugins
65
79
66
-
SharpFM supports plugins via the `SharpFM.Plugin` contract library. Plugins implement `IPanelPlugin` and are loaded from the `plugins/` directory at startup. You can also install and manage plugins from the **View > Manage Plugins...** menu.
80
+
SharpFM supports plugins via the `SharpFM.Plugin` contract library. Plugins are loaded from the `plugins/` directory at startup and can be managed from **Plugins > Manage Plugins...**.
81
+
82
+
### Bundled Plugins
67
83
68
-
A sample "Clip Inspector" plugin is included to demonstrate the plugin API.
84
+
-**XML Viewer** -- Live XML panel with syntax highlighting and bidirectional sync (`Ctrl+Shift+X`).
1. Create a new .NET 8 class library referencing `SharpFM.Plugin`.
73
-
2. Implement `IPanelPlugin` — provide an `Id`, `DisplayName`, and `CreatePanel()` returning an Avalonia `Control`.
74
-
3. Use `IPluginHost` in `Initialize()` to observe clip selection and push XML updates.
75
-
4. Build your DLL and drop it in the `plugins/` directory.
89
+
1. Create a .NET 8 class library referencing `SharpFM.Plugin`.
90
+
2. Implement `IPanelPlugin` -- provide an `Id`, `DisplayName`, `CreatePanel()` returning an Avalonia `Control`.
91
+
3. Use `IPluginHost` in `Initialize()` to observe clip selection changes and content updates.
92
+
4. Optionally register keyboard shortcuts via `KeyBindings` and custom menu actions via `MenuActions`.
93
+
5. Build the DLL and drop it in the `plugins/` directory.
76
94
77
95
See `src/SharpFM.Plugin.Sample/` for a complete working example.
78
96
79
-
### License
97
+
### Plugin License
80
98
81
99
While SharpFM is licensed under GPL v3, plugins that communicate solely through the interfaces in `SharpFM.Plugin` are not required to be GPL-licensed. See the plugin interface source files for the full exception clause.
82
100
@@ -91,6 +109,6 @@ Logs are stored in `${specialfolder:folder=CommonApplicationData}\SharpFM` and a
0 commit comments