doc: Fetch latest manual

Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
James Valleroy 2024-08-12 22:07:08 -04:00
parent d8beb8727f
commit 246e356fd6
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
14 changed files with 307 additions and 0 deletions

View File

@ -0,0 +1,84 @@
#language en
##TAG:TRANSLATION-HEADER-START
~- [[FreedomBox/Manual/FeatherWiki|English]] - [[es/FreedomBox/Manual/FeatherWiki|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
##TAG:TRANSLATION-HEADER-END
<<TableOfContents()>>
## BEGIN_INCLUDE
== Feather Wiki (Personal Notebooks) ==
||<tablestyle="float: right;"> {{attachment:Feather-Wiki-on-FreedomBox.png|Feather Wiki icon}} ||
'''Available since''': version 24.17
Feather Wiki is a simple tool to create personal wikis on the web. Each wiki is self-contained within a single HTML file stored on your !FreedomBox. Only !FreedomBox users can read or write to the wiki files. It is also possible to "publish" a Feather Wiki file from within the application.
=== A Nest of Feather Wikis ===
Feather Wiki is a web application that runs entirely in the browser. !FreedomBox implements a Feather Wiki Nest, i.e. an application that can store and manage several Feather Wiki files.
Feather Wiki is a web quine, like its more popular, older and more feature-rich cousin !TiddlyWiki. Every wiki file contains an entire copy of the source code (HTML, CSS and !JavaScript) along with your content, which makes it extremely portable.
The Nest is essentially a !WebDAV server provided by !FreedomBox's Apache web server, so Feather Wiki doesn't require installation of any additional packages. It requires no additional system resources either, since Apache is always running.
=== Setting up wikis ===
Creating and deleting wiki files is handled by the !FreedomBox app itself. Every new wiki file is created from the latest available version of the empty Feather Wiki file downloaded from the official website. Deletion cannot be undone. You have to either restore the deleted file from a backup or import any saved local copy into a new wiki file. Uploading your existing Feather Wiki files is supported if they are at least v1.8.0 (Skylark). For older Feather Wiki files, you can use the import option as described below.
To import an old Feather Wiki file, first create a new wiki on your !FreedomBox.The page called "Wiki Settings" in Feather Wiki provides a button that lets you import the contents of an existing wiki file into a new wiki by uploading the file from your local machine.
Upgrading Feather Wiki is a manual process that is very similar to importing.
1. Save a local copy of the wiki file.
2. Delete the wiki file from the server.
3. Create a new empty wiki file (this will be of the latest version by default).
4. Open the new wiki.
5. Import the contents of your local copy into the new wiki from the "Wiki Settings" page.
{{attachment:Feather-Wiki-Settings.png|Wiki Settings page|width=800}}
=== Publishing a wiki ===
The Feather Wiki app on !FreedomBox doesn't provide a "public access" option, unlike !MediaWiki. To share your wiki file with someone who doesn't have an account on your !FreedomBox or to publish the file on the Internet, follow these steps:
1. Save a local copy of the wiki file.
2. Open the local copy in a web browser.
3. Go to "Wiki Settings" page and enable the "Publish" setting. (This makes the wiki non-editable. Hence the local copy.)
4. Save the local copy.
Now you can share the HTML file or publish it on the web using [[FreedomBox/Manual/Apache_userdir|Apache userdir]] or placing it under the /var/www/html directory on your !FreedomBox.
=== As many wikis as you need ===
The source code of Feather Wiki is tiny - less than 60 kilobytes. You are encouraged to create as many wiki files as you need, since the storage cost of each file is negligible, even on a !FreedomBox running from an SD card.
The shortcut for Feather Wiki app opens a page with the list of wiki files stored on !FreedomBox. Creating a front page shortcut for each wiki file (like Ikiwiki does) would clutter the front page, considering the number of Feather Wiki files people might create.
=== Use cases ===
* '''Notebook:''' A student can use Feather Wiki as a web notebook with one wiki file per course. About 40 files for a bachelor's degree!
* '''Self-publishing:''' An author can self-publish an online book using Feather Wiki as a !GitBook alternative.
* '''Refile:''' One wiki file as a general notes dump that can be refiled later into more organized formats.
* One wiki file for each issue of a magazine (indie web zine) maybe with some custom CSS added.
* Simple internal websites for organizations to publish information.
* One Feather Wiki file for each of your projects. Keep all project-related notes and tasks in one file.
* Shipping documentation/user-guide with your product, in a single file.
For more inspiration, see the [[https://feather.wiki/?page=gallery|Gallery]] on the official website.
You might want to configure your wiki with different [[https://feather.wiki/?page=extensions|extensions]] for Feather Wiki depending on the use case.
=== External links ===
* Website: https://feather.wiki
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

View File

@ -8,6 +8,49 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 24.17 (2024-08-12) ==
=== Highlights ===
* featherwiki: Add new app for Personal Notebooks
* tiddlywiki: Add new app for Non-linear Notebooks
=== Other Changes ===
* COPYING.md: Update copyright years
* actions: Add error when likely parameters are not marked as secret
* actions: Define and allow a new alias for str; secret_str
* actions: Log arguments without secret strings in privileged calls
* apache: Enable dav and dav_fs modules
* backups: Mark secret strings in privileged actions
* base.html: Drop dependency on modernizr.js library
* bepasty: Mark secret strings in privileged actions
* django: settings: Don't set USE_L10N on newer versions
* featherwiki: Fix a type check failure
* featherwiki: Proxy download through freedombox.org
* firewall: Setup inter-zone forwarding
* gitweb: Don't backup/restore a drop-in configuration file
* ikiwiki: Mark secret strings in privileged actions
* locale: Update translations for Albanian, Bulgarian, Chinese (Simplified), Czech, Spanish, Turkish
* makefile: Don't fail while building and installing multiple versions
* mediawiki: Mark secret strings in privileged actions
* miniflux: Mark secret strings in privileged actions
* mumble: Mark secret strings in privileged actions
* nextcloud: Mark secret strings in privileged actions
* nextcloud: Prevent process restart when nextcloud is uninstalled
* nextcloud: Redirect to URL nextcloud/ if ending slash is not given
* nextcloud: tests: functional: Add base and interface tests
* pagekite: Mark secret strings in privileged actions
* rssbridge: tests: Add missing {{{__init__.py}}}
* shadowsocks: Mark secret strings in privileged actions
* shadowsocksserver: Mark secret strings in privileged actions
* ssh: Mark secret strings in privileged actions
* storage: Add diagnostic for grub config issue
* templates: Fix warning about using default.html for form template
* tests: functional: Allow submitting form buttons along with inputs
* tests: functional: Name the background fixture
* users: Mark secret strings in privileged actions
== FreedomBox 24.16 (2024-07-29) ==
=== Highlights ===

View File

@ -0,0 +1,63 @@
#language en
##TAG:TRANSLATION-HEADER-START
~- [[FreedomBox/Manual/TiddlyWiki|English]] - [[es/FreedomBox/Manual/TiddlyWiki|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
##TAG:TRANSLATION-HEADER-END
<<TableOfContents()>>
## BEGIN_INCLUDE
== TiddlyWiki (Non-linear Notebooks) ==
||<tablestyle="float: right;"> {{attachment:TiddlyWiki-on-FreedomBox.png|TiddlyWiki icon}} ||
'''Available since''': version 24.17
!TiddlyWiki is an interactive, nonlinear web notebook for capturing and organizing complex information. It can serve as a knowledge management system for one person. It is portable (single HTML file), highly customizable and easy to use. Despite being a single HTML file, !TiddlyWiki can embed multiple types of media - images, audio, video and PDF files (or refer to them by file paths, not as portable). It can also store data in JSON format.
=== TiddlyWiki on FreedomBox ===
!FreedomBox includes a native implementation of a Feather Wiki Nest (a server to save your wiki files). The same is used to host !TiddlyWiki files. This implementation is not as efficient as the official !TiddlyWiki server which can save one Tiddler at a time, instead of saving the entire HTML file.
==== Bandwidth considerations with the Autosave setting ====
Each empty !TiddlyWiki file (2.4 MB) is 40x the size of an empty Feather Wiki file (60 KB). !TiddlyWiki has autosave enabled by default. This causes the entire wiki file to be transmitted to the server, each time an individual Tiddler is saved. You might write long wiki pages in Feather Wiki, but !TiddlyWiki encourages writing lots of short Tiddlers which results in more saves for the same amount of text. !TiddlyWiki files tend to grow large as you add media content, with people growing their wikis to 100 MB in size over the years.
If you are editing while using mobile data or you are connected via a dial-up connection, hundreds of (2.4 MB + content) saves can add up quickly. In such cases, it is recommended to disable autosave from the settings and save manually.
{{attachment:TiddlyWiki-Autosave.png|TiddlyWiki Autosave Settings|width=800}}
=== Use cases ===
* '''Personal Wiki''': !TiddlyWiki can be used as a personal wiki to store all kinds of information in short notes called Tiddlers. It can hold a small database of your personal knowledge that is linked in a graph and easy to search and organize.
* '''Research Notes''': !TiddlyWiki can be used as a zettelkasten or a second brain. This can lead to new creative insights across different concepts.
* '''Encrypted Journal/Diary''': !TiddlyWiki supports [[https://tiddlywiki.com/static/Encryption.html|password-protection]] and journal entries (a Tiddler with today's date as the title). Your personal diary/journal can be one !TiddlyWiki file. Engineering Daybooks is a similar use case, but for work.
* !TiddlyWiki can be used as a project management tool, e.g. for wedding planning.
* !TiddlyWiki's !WikiText though declarative can be used to create interactive content such as flash cards and automatically-updating lists. There is support for templates and !JavaScript macros.
* '''Linkblog''': A !TiddlyWiki file can work as a replacement for Shaarli if you want to keep all of your bookmarks private.
* !TiddlyWiki can be used as a bug tracker for your projects on !GitWeb.
=== Upgrades ===
Upgrading !TiddlyWiki is a manual process.
1. Save a local copy of the file from your browser. Right click -> Save page as...
2. Use the web-based [[https://tiddlywiki.com/upgrade.html|Upgrade Wizard]] from the official website.
3. After downloading the upgraded file, load it into a browser to verify your content.
4. Replace the older file on your !FreedomBox with the upgraded file.
If you ever lose a !TiddlyWiki file, you can always retrieve a slightly outdated copy from the Backups app. It is better to keep your local copy after the upgrade, in case you want to revert.
=== External links ===
* Website: https://tiddlywiki.com
* Grok !TiddlyWiki (online e-book): https://groktiddlywiki.com/read/
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

View File

@ -22,6 +22,7 @@
<<Include(FreedomBox/Manual/Deluge, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/ejabberd, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Email, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/FeatherWiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/GitWeb, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/I2P, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Ikiwiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
@ -46,6 +47,7 @@
<<Include(FreedomBox/Manual/Shadowsocks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Sharing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Syncthing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TiddlyWiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TinyTinyRSS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Tor, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TorProxy, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

View File

@ -22,6 +22,7 @@
<<Include(FreedomBox/Manual/Deluge, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/ejabberd, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Email, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/FeatherWiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/GitWeb, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/I2P, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Ikiwiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
@ -46,6 +47,7 @@
<<Include(FreedomBox/Manual/Shadowsocks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Sharing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Syncthing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TiddlyWiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TinyTinyRSS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Tor, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TorProxy, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>

View File

@ -8,6 +8,49 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 24.17 (2024-08-12) ==
=== Highlights ===
* featherwiki: Add new app for Personal Notebooks
* tiddlywiki: Add new app for Non-linear Notebooks
=== Other Changes ===
* COPYING.md: Update copyright years
* actions: Add error when likely parameters are not marked as secret
* actions: Define and allow a new alias for str; secret_str
* actions: Log arguments without secret strings in privileged calls
* apache: Enable dav and dav_fs modules
* backups: Mark secret strings in privileged actions
* base.html: Drop dependency on modernizr.js library
* bepasty: Mark secret strings in privileged actions
* django: settings: Don't set USE_L10N on newer versions
* featherwiki: Fix a type check failure
* featherwiki: Proxy download through freedombox.org
* firewall: Setup inter-zone forwarding
* gitweb: Don't backup/restore a drop-in configuration file
* ikiwiki: Mark secret strings in privileged actions
* locale: Update translations for Albanian, Bulgarian, Chinese (Simplified), Czech, Spanish, Turkish
* makefile: Don't fail while building and installing multiple versions
* mediawiki: Mark secret strings in privileged actions
* miniflux: Mark secret strings in privileged actions
* mumble: Mark secret strings in privileged actions
* nextcloud: Mark secret strings in privileged actions
* nextcloud: Prevent process restart when nextcloud is uninstalled
* nextcloud: Redirect to URL nextcloud/ if ending slash is not given
* nextcloud: tests: functional: Add base and interface tests
* pagekite: Mark secret strings in privileged actions
* rssbridge: tests: Add missing {{{__init__.py}}}
* shadowsocks: Mark secret strings in privileged actions
* shadowsocksserver: Mark secret strings in privileged actions
* ssh: Mark secret strings in privileged actions
* storage: Add diagnostic for grub config issue
* templates: Fix warning about using default.html for form template
* tests: functional: Allow submitting form buttons along with inputs
* tests: functional: Name the background fixture
* users: Mark secret strings in privileged actions
== FreedomBox 24.16 (2024-07-29) ==
=== Highlights ===

View File

@ -0,0 +1,69 @@
#language es
<<Include(FreedomBox/Manual/TiddlyWiki, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
<<TableOfContents()>>
## BEGIN_INCLUDE
== TiddlyWiki (Bloc de notas no lineal) ==
||<tablestyle="float: right;"> {{attachment:FreedomBox/Manual/TiddlyWiki/TiddlyWiki-on-FreedomBox.png|Icono de Tiddly}} ||
'''Disponible desde''': versión 24.17
!TiddlyWiki en un bloc de notas web no lineal interactivo para capturar y organizar información compleja. Puede servir como un sistema unipersonal de gestión de conocimientos.
Es portable (un único archvo HTML), altamente personalizable y fácil de usar.
Pese a ser un único archivo HTML !TiddlyWiki puede incrustar multiples tipos de multimedia - imagenes, audio, video y archivos PDF (o apuntar a ellos mediante rutas, aunque esto ya no es tán portable).
También puede almacenar datos en formato JSON.
=== TiddlyWiki en FreedomBox ===
!FreedomBox incluye una implementación nativa de un nido Feather Wiki (un servidor para guardar tus archivos de wiki). Se usa el mismo para alojar los archivos !TiddlyWiki.
Esta implementación no es tán eficiente como el servidor oficial !TiddlyWiki, que puede grabar entradas (''Tiddlers'') individualmente, en vez de grabar todo el archivo HTML.
==== Consideraciones respecto al ancho de banda en la configuración de grabación automática ====
Cada archivo !TiddlyWiki vacío es 40 veces mayor (2.4 MB) que uno de Feather Wiki (60 KB). !TiddlyWiki viene con la grabación automática activa por omisión.
Esto provoca que se transmita al servidor el archivo entero cada vez que se guarda un ''Tiddler''.
En Feather Wiki el texto es corrido así que quizá escribas páginas largas pero !TiddlyWiki invita a escribir muchos ''Tiddlers'' cortos, lo que deviene en más grabaciones por el mismo texto.
Los archivos de !TiddlyWiki tienden a crecer a medida que añades contenido multimedia. Hay a quien le crecen sus wikis hasta 100 MB con el transcurso de los años.
Si editas con datos móviles o por conexión telefónica, cientos de grabaciones de 2.4 MB + contenido se notan. En estos casos se recomienda deshabilitar la
grabación automática en los ajustes y grabar a mano.
{{attachment:FreedomBox/Manual/TiddlyWiki/TiddlyWiki-Autosave.png|Ajuste de grabación automática en TiddlyWiki|width=800}}
=== Casos de uso ===
* '''Wiki personal''': !TiddlyWiki se puede usar como wiki personal para almacenar todo tipo de información en notas cortas llamadas ''Tiddlers''. Puede alojar una pequeña base de datos de perlas de conocimiento personal enlazadas en estructura de grafo y fáciles de busar y organizar.
* '''Notas de investigación''': !TiddlyWiki se puede usar como un tarjetero o un segundo cerebro. Esto puede llevar a revelaciones creativas cruzando conceptos diferentes.
* '''Diario cifrado''': !TiddlyWiki soporta [[https://tiddlywiki.com/static/Encryption.html|protección mediante contraseña]] y secuencias de entradas (un ''Tiddler'' con la fecha del día como título). Tu diario personal puede ser un archivo !TiddlyWiki.
* !TiddlyWiki se puede emplear para gestión de proyectos, por ejemplo planificar una boda.
* Aunque el formato de !TiddlyWiki's es declarativo se puede usar para crear contenido interactivo como tarjetas flash y listas auto-actualizadas. Soporta plantillas y macros en !JavaScript.
* '''Blog de enlaces''': Un archivo !TiddlyWiki puede reemplazar a Shaarli si quieres mantener tus marcapáginas privados.
* !TiddlyWiki se puede usar como gestor de incidencias para tus proyectos de !GitWeb.
=== Actualizaciones ===
Actualizar !TiddlyWiki es un proceso manual.
1. Salva una copia local del fichero desde tu navegador. Haz clic con el botón derecho del ratón -> Guardar como...
2. Usa el [[https://tiddlywiki.com/upgrade.html|Asistente de actualización]] del sitio web oficial.
3. Tras descargar el archivo actualizado, cárgalo al navegador para verificar tu contenido.
4. Reemplaza el archivo antiguo en tu !FreedomBox con el archivo actualizado.
Si alguna vez pierdes un archivo !TiddlyWiki puedes recuperar una copia ligaramente anticuada de la app de Copias de Respaldo. Es mejor conservar tu copia local tras la actualización, si quieres revertir.
=== Enlaces externos ===
* Proyecto original: https://tiddlywiki.com
* Grok !TiddlyWiki (libro electrónico en línea): https://groktiddlywiki.com/read/
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

View File

@ -45,6 +45,7 @@
<<Include(es/FreedomBox/Manual/Shadowsocks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(es/FreedomBox/Manual/Sharing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(es/FreedomBox/Manual/Syncthing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(es/FreedomBox/Manual/TiddlyWiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(es/FreedomBox/Manual/TinyTinyRSS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(es/FreedomBox/Manual/Tor, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(es/FreedomBox/Manual/TorProxy, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB