rzerres/element-call-book
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lib.rs: update annotations

Browse Source 
* image path
* translation hints
* unicode icons
This commit is contained in:
Ralf Zerres
2024-10-21 11:20:26 +02:00
parent 21db004362
commit a96159a27b
3 changed files with 25 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -1,11 +1,14 @@
# element-call-book
![Welcome to the element-call book.][element_call_book]
Welcome to the Element-Call book.
[element_call_book]: https://gitea.networkx.de/rzerres/element-call-book/src/branch/main/src/img/element-call-webui.png "Element-Call UI"
![Element-Call book][element_call_book]
This repository contains the text source for "The Element-Call" book.
We will further reference to it as the `Element-Call Book`.
[element_call_book]: https://gitea.networkx.de/rzerres/element-call-book/src/branch/main/src/img/element-call-webui.png
<!--
WIP: once it is ready to be shipped
[The book is available in dead-tree form from No Starch Press][nostarch].
@@ -25,7 +28,7 @@ We will further reference to it as the `Element-Call Book`.
[releases]: https://element.io/element-call/book/releases
-->
#### Requirements
#### ☝ Requirements
##### mdBook
Building the book requires [mdBook] and its helper tools. The used
@@ -98,7 +101,7 @@ $ cargo readme > README.md
[mdBook localization]: https://github.com/Nutomic/mdBook/tree/localization
[rust-mdbook]: https://github.com/rust-lang/rust/blob/master/src/tools/rustbook/Cargo.toml
#### Building
#### ☕ Building
##### Building the book
@@ -173,7 +176,7 @@ on Matrix, featuring real humans!
<!--
WIP: once it is ready to be shipped
#### Code of Conduct
#### 🌻 Code of Conduct
We are committed to providing a friendly, safe and welcoming
environment. Read more about our policy in the [code-of-conduct][coc] page.
@@ -186,21 +189,17 @@ environment. Read more about our policy in the [code-of-conduct][coc] page.
[element-call-room-matrix]: https://matrix.to/#/#element-call-dev:matrix.org>`_`
-->
##### Translations
#### 🌐 Translations
We'd love help to translate the book! See the [Translations] label
to join in efforts that are currently in progress. Open a new
issue to start working on a new language! We're waiting on [mdbook
support] for multiple languages to be finalized, but feel free to
start! A [pull request] looks promising. The mainline version (we
do depend on v0.4.12) is capable to render the existing versions
where sources are installed in the intended final structure.
issue to start working on a new language!
[Translations]: https://gitea.networkx.de/rzerres/element-call/book/issues?q=is%3Aopen+is%3Aissue+label%3ATranslations
[mdbook support]: https://github.com/rust-lang-nursery/mdBook/issues/5
[pull request]: https://github.com/rust-lang/mdBook/pull/1306
#### Spellchecking
#### ✒ Spellchecking
To scan source files for spelling errors, you can use the `spellcheck.sh`
script. It needs a dictionary of valid words, which is provided in
@@ -208,7 +207,7 @@ script. It needs a dictionary of valid words, which is provided in
`BTreeMap` which the script considers invalid), you need to add this word to
`dictionary.txt` (keep the sorted order for consistency).
#### License
#### ⚜ License
<!-- License source -->
[Logo-CC_BY]: https://i.creativecommons.org/l/by/4.0/88x31.png "Creative Common Logo"

25
src/lib.rs
View File

@@ -1,12 +1,15 @@
#![crate_name = "element_call_book"]
#![crate_type = "lib"]
//! ![Welcome to the element-call book.][element_call_book]
//! Welcome to the Element-Call book.
//!
//! [element_call_book]: https://gitea.networkx.de/rzerres/element-call-book/src/branch/main/src/img/element-call-webui.png "Element-Call UI"
//! ![Element-Call book][element_call_book]
//!
//! This repository contains the text source for "The Element-Call" book.
//! We will further reference to it as the `Element-Call Book`.
//!
//! [element_call_book]: https://gitea.networkx.de/rzerres/element-call-book/src/branch/main/src/img/element-call-webui.png
//!
//! <!--
//! WIP: once it is ready to be shipped
//! [The book is available in dead-tree form from No Starch Press][nostarch].
@@ -26,7 +29,7 @@
//! [releases]: https://element.io/element-call/book/releases
//! -->
//!
//! ### Requirements
//! ### ☝ Requirements
//!
//! #### mdBook
//! Building the book requires [mdBook] and its helper tools. The used
@@ -99,7 +102,7 @@
//! [mdBook localization]: https://github.com/Nutomic/mdBook/tree/localization
//! [rust-mdbook]: https://github.com/rust-lang/rust/blob/master/src/tools/rustbook/Cargo.toml
//!
//! ### Building
//! ### ☕ Building
//!
//! #### Building the book
//!
@@ -174,7 +177,7 @@
//!
//! <!--
//! WIP: once it is ready to be shipped
//! ### Code of Conduct
//! ### 🌻 Code of Conduct
//!
//! We are committed to providing a friendly, safe and welcoming
//! environment. Read more about our policy in the [code-of-conduct][coc] page.
@@ -187,21 +190,17 @@
//! [element-call-room-matrix]: https://matrix.to/#/#element-call-dev:matrix.org>`_`
//! -->
//!
//! #### Translations
//! ### 🌐 Translations
//!
//! We'd love help to translate the book! See the [Translations] label
//! to join in efforts that are currently in progress. Open a new
//! issue to start working on a new language! We're waiting on [mdbook
//! support] for multiple languages to be finalized, but feel free to
//! start! A [pull request] looks promising. The mainline version (we
//! do depend on v0.4.12) is capable to render the existing versions
//! where sources are installed in the intended final structure.
//! issue to start working on a new language!
//!
//! [Translations]: https://gitea.networkx.de/rzerres/element-call/book/issues?q=is%3Aopen+is%3Aissue+label%3ATranslations
//! [mdbook support]: https://github.com/rust-lang-nursery/mdBook/issues/5
//! [pull request]: https://github.com/rust-lang/mdBook/pull/1306
//!
//! ### Spellchecking
//! ### ✒ Spellchecking
//!
//! To scan source files for spelling errors, you can use the `spellcheck.sh`
//! script. It needs a dictionary of valid words, which is provided in
@@ -209,7 +208,7 @@
//! `BTreeMap` which the script considers invalid), you need to add this word to
//! `dictionary.txt` (keep the sorted order for consistency).
//!
//! ### License
//! ### ⚜ License
//!
//! <!-- License source -->
//! [Logo-CC_BY]: https://i.creativecommons.org/l/by/4.0/88x31.png "Creative Common Logo"

2
src/title-page.md
View File

@@ -2,7 +2,7 @@
![Element-Call][element_call]
[element_call]: https://gitea.networkx.de/rzerres/element-call-book/blob/main/src/img/element-call.png
[element_call]: ./img/element-call.png
*annotated and documented by Ralf Zerres and all contributers*