goldcollection
/
muwire
mirror of https://github.com/zlatinb/muwire
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document sidecar files

master
Zlatin Balevsky 2019-10-31 19:45:46 +00:00
parent 873bab9f6e
commit 6e43f82def
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Sidecar-files.md 100644

@ -0,0 +1,15 @@
# Sidecar files
Sidecar files are text files that you can use to automatically add comments to your shared files. The sidecar files themselves are not shared, but their content is added as a comment
to the corresponding shared file. If the searcher has not disabled searching in comments, any word present in a comment will trigger search results.
* The sidecar file is a regular text file, but it will be loaded as UTF-8 so you can use foreign languages.
* The sidecar file must be present in the same directory as the corresponding shared file and have the same name but with the added extension of ".mwcomment"
* The maximum length of a comment is 32kb. If a sidecar file is longer than that, it will be ignored.
* You need to share the sidecar file for it to be processed. It will not appear in your list of shared files, but the corresponding shared file will be updated to have a comment.
* If you change the contents of the sidecar file it will not update the comment automatically. You need to manually re-share the sidecar file for that to happen.
* If you change the comment of a file through the UI, it will not change the sidecar file.
* If you delete the sidecar file, the comment in the share file will not be affected. If you want to remove a comment completely you need to do it through the UI.
### Note about symlinks
MuWire resolves all symlinks. If you use symlinks for your shared files or sidecar files, the final resolved path of the sidecar file and the shared file must be the same in order for the sidecar file to be processed.