From a3fccb33150541d13ec10f824f42a3f677ac82fc Mon Sep 17 00:00:00 2001 From: Silberengel Date: Tue, 8 Apr 2025 08:22:36 +0200 Subject: [PATCH 1/3] Reformatted About page, fixed broken hyperlinks, added project documentation page, and made all internal links relative. --- src/routes/about/+page.svelte | 143 ++++++++++++++++++++++------------ 1 file changed, 94 insertions(+), 49 deletions(-) diff --git a/src/routes/about/+page.svelte b/src/routes/about/+page.svelte index 9e4ee80..6f4f96a 100644 --- a/src/routes/about/+page.svelte +++ b/src/routes/about/+page.svelte @@ -1,56 +1,101 @@
-
- About -

Alexandria is a reader and writer for curated publications (in Asciidoc), and will eventually also support long-form articles (Markdown) and wiki pages (Asciidoc). It is produced by the GitCitadel project team.

- -

Please submit support issues on the project repo page and follow us on GitHub and Geyserfund.

- -

We are easiest to contact over our Nostr address npub1s3h…75wz.

- - Overview - -

Alexandria opens up to the landing page, where the user can: login (top-right), select whether to only view the publications hosted on the thecitadel document relay or add in their own relays, and scroll/search the publications.

- -

Landing page

-

Relay selection

- -

There is also the ability to view the publications as a diagram, if you click on "Visualize", and to publish an e-book or other document (coming soon).

- -

If you click on a card, which represents a 30040 index event, the associated reading view opens to the publication. The app then pulls all of the content events (30041s), in the order in which they are indexed, and displays them as a single document.

+
+ About -

Each 30041 section is also a level in the table of contents, which can be accessed from the floating icon top-left in the reading view. This allows for navigation within the publication. (This functionality has been temporarily disabled.)

- -

ToC icon

-

Table of contents example

- - Typical use cases - - For e-books -

The most common use for Alexandria is for e-books: both those users have written themselves and those uploaded to Nostr from other sources. The first minor version of the app, Gutenberg, is focused on displaying and producing these publications.

- -

An example of a book is Jane Eyre

- -

Jane Eyre, by Charlotte Brontë

- - For scientific papers -

Alexandria will also display research papers with Asciimath and LaTeX embedding, and the normal advanced formatting options available for Asciidoc. In addition, we will be implementing special citation events, which will serve as an alternative or addition to the normal footnotes.

+

+ Alexandria is a reader and writer for curated publications (in Asciidoc), and will eventually also support long-form articles (Markdown) and wiki pages (Asciidoc). It is produced by the GitCitadel project team. +

-

Correctly displaying such papers, integrating citations, and allowing them to be reviewed (with kind 1111 comments), and annotated (with highlights) by users, is the focus of the second minor version, Euler.

+

+ Please submit support issues on the project repo page and follow us on GitHub and Geyserfund. +

-

Euler will also pioneer the HTTP-based (rather than websocket-based) e-paper compatible version of the web app.

- -

An example of a research paper is Less Partnering, Less Children, or Both?

- -

Research paper

- - For documentation -

Our own team uses Alexandria to document the app, to display our blog entries, as well as to store copies of our most interesting technical specifications.

- -

Documentation

- -
-
\ No newline at end of file +

+ We are easiest to contact over our Nostr address npub1s3h…75wz. +

+ + Overview + +

+ Alexandria opens up to the landing page, where the user can: login (top-right), select whether to only view the publications hosted on the thecitadel document relay or add in their own relays, and scroll/search the publications. +

+ +
+ Landing page + Relay selection +
+ +

+ There is also the ability to view the publications as a diagram, if you click on "Visualize", and to publish an e-book or other document (coming soon). +

+ +

+ If you click on a card, which represents a 30040 index event, the associated reading view opens to the publication. The app then pulls all of the content events (30041s), in the order in which they are indexed, and displays them as a single document. +

+ +

+ Each 30041 section is also a level in the table of contents, which can be accessed from the floating icon top-left in the reading view. This allows for navigation within the publication. (This functionality has been temporarily disabled.) +

+ +
+ ToC icon + Table of contents example +
+ + Typical use cases + + For e-books +
+ +

+ The most common use for Alexandria is for e-books: both those users have written themselves and those uploaded to Nostr from other sources. The first minor version of the app, Gutenberg, is focused on displaying and producing these publications. +

+ +

+ An example of a book is Jane Eyre +

+ +
+ Jane Eyre, by Charlotte Brontë +
+ + For scientific papers +
+ +

+ Alexandria will also display research papers with Asciimath and LaTeX embedding, and the normal advanced formatting options available for Asciidoc. In addition, we will be implementing special citation events, which will serve as an alternative or addition to the normal footnotes. +

+ +

+ Correctly displaying such papers, integrating citations, and allowing them to be reviewed (with kind 1111 comments), and annotated (with highlights) by users, is the focus of the second minor version, Euler. +

+ +

+ Euler will also pioneer the HTTP-based (rather than websocket-based) e-paper compatible version of the web app. +

+ +

+ An example of a research paper is Less Partnering, Less Children, or Both? +

+ +
+ Research paper +
+ + For documentation +
+ +

+ Our own team uses Alexandria to document the app, to display our blog entries, as well as to store copies of our most interesting technical specifications. +

+ +
+ Documentation +
+ + + From bc8bd6f847122bcb55c76c33c71045b68ee6bfe7 Mon Sep 17 00:00:00 2001 From: Silberengel Date: Tue, 8 Apr 2025 08:56:37 +0200 Subject: [PATCH 2/3] Corrected more links. Tried to make the horizontal rules (Hr) more apparent, in light view, but it didn't work. --- src/routes/about/+page.svelte | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/routes/about/+page.svelte b/src/routes/about/+page.svelte index 6f4f96a..627bc30 100644 --- a/src/routes/about/+page.svelte +++ b/src/routes/about/+page.svelte @@ -7,11 +7,11 @@ About

- Alexandria is a reader and writer for curated publications (in Asciidoc), and will eventually also support long-form articles (Markdown) and wiki pages (Asciidoc). It is produced by the GitCitadel project team. + Alexandria is a reader and writer for curated publications (in Asciidoc), and will eventually also support long-form articles (Markdown) and wiki pages (Asciidoc). It is produced by the GitCitadel project team.

- Please submit support issues on the project repo page and follow us on GitHub and Geyserfund. + Please submit support issues on the Alexandria repo page and follow us on GitHub and Geyserfund.

@@ -49,7 +49,7 @@ Typical use cases For e-books -

+

The most common use for Alexandria is for e-books: both those users have written themselves and those uploaded to Nostr from other sources. The first minor version of the app, Gutenberg, is focused on displaying and producing these publications. @@ -64,7 +64,7 @@ For scientific papers -

+

Alexandria will also display research papers with Asciimath and LaTeX embedding, and the normal advanced formatting options available for Asciidoc. In addition, we will be implementing special citation events, which will serve as an alternative or addition to the normal footnotes. @@ -87,7 +87,7 @@ For documentation -

+

Our own team uses Alexandria to document the app, to display our blog entries, as well as to store copies of our most interesting technical specifications. From 61d25cb1ca32d331c048a404119f9a46e4879749 Mon Sep 17 00:00:00 2001 From: Silberengel Date: Tue, 8 Apr 2025 20:56:08 +0200 Subject: [PATCH 3/3] Removed the rules. --- src/routes/about/+page.svelte | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/src/routes/about/+page.svelte b/src/routes/about/+page.svelte index 627bc30..60d3738 100644 --- a/src/routes/about/+page.svelte +++ b/src/routes/about/+page.svelte @@ -1,5 +1,5 @@

@@ -49,7 +49,6 @@ Typical use cases For e-books -

The most common use for Alexandria is for e-books: both those users have written themselves and those uploaded to Nostr from other sources. The first minor version of the app, Gutenberg, is focused on displaying and producing these publications. @@ -64,8 +63,7 @@

For scientific papers -
- +

Alexandria will also display research papers with Asciimath and LaTeX embedding, and the normal advanced formatting options available for Asciidoc. In addition, we will be implementing special citation events, which will serve as an alternative or addition to the normal footnotes.

@@ -87,8 +85,7 @@ For documentation -
- +

Our own team uses Alexandria to document the app, to display our blog entries, as well as to store copies of our most interesting technical specifications.