Zextras Product Documentation

https://github.com/zextras/tech-doc-user
Admin
This repository provides the source code for Zextras product documentation, written with Python...
Tokens:939
Snippets:9
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Python Requirements for Sphinx Documentation

Source: https://github.com/zextras/tech-doc-user/blob/devel/README.md

Installs all necessary Python packages for building the Zextras product documentation using Sphinx. This command reads the package list from the 'requirements.txt' file.

```shell
pip install -r requirements.txt
```

--------------------------------

### Zextras Search Keywords Examples

Source: https://github.com/zextras/tech-doc-user/blob/devel/source/carbonio/search/toc.rst

Demonstrates the usage of various keywords for content searching in Zextras. These keywords help narrow down search results by specifying criteria such as sender, recipient, subject, folder, attachments, and message status.

```text
content:important
from:"john.doe"
to:"jane.smith"
cc:"Manager"
subject:meeting
in:sent
has:attachment
filename:report.pdf
type:excel
attachment:word
is:unread
date:02/20/2024
after:01/01/2024
before:03/01/2024
size:1MB
smaller:1MB
larger:1MB
tag:important
```

--------------------------------

### Zextras Wildcard Usage Example

Source: https://github.com/zextras/tech-doc-user/blob/devel/source/carbonio/search/toc.rst

Illustrates the use of the asterisk (*) wildcard character in Zextras searches to find words with similar spellings. For example, searching for 'dog' will also return results for 'doggy' and 'doghouse'. Note that double-byte asterisks are ignored.

```text
dog*
```

--------------------------------

### Get ICS Free/Busy URL Format

Source: https://github.com/zextras/tech-doc-user/blob/devel/source/carbonio/calendars/toc.rst

This snippet shows the format for the ICS Free/Busy URL. This URL allows external users to view availability without accessing event details. It requires the domain and the user's email address.

```URL
https://mail.yourdomain.com/service/pubcal/freebusy.ifb?acct=your-email@yourdomain.com
```

--------------------------------

### Build All Product Documentation (HTML)

Source: https://github.com/zextras/tech-doc-user/blob/devel/README.md

Executes the documentation build process for all Zextras products (carbonio, carbonio-ce, suite) by running 'make html' in their respective source sub-folders. The output is generated in the 'build' directory.

```shell
./doc_build_all.sh
```

--------------------------------

### Serve Documentation Locally with Python HTTP Server

Source: https://github.com/zextras/tech-doc-user/blob/devel/README.md

Serves the generated static HTML documentation files from the 'build' directory on a local HTTP server. This allows for local browsing and testing of the documentation. Users can access it via localhost:8000 in their browser.

```shell
python3 -m http.server --directory build 8000
```

--------------------------------

### Build Single Product Documentation (HTML)

Source: https://github.com/zextras/tech-doc-user/blob/devel/README.md

Builds the HTML documentation for a single Zextras product by executing 'make html' within that product's directory (e.g., 'carbonio', 'carbonio-ce', or 'suite').

```shell
make html
```

--------------------------------

### Upgrade Python Requirements for Sphinx Documentation

Source: https://github.com/zextras/tech-doc-user/blob/devel/README.md

Upgrades all Python packages listed in the 'requirements.txt' file to their latest versions, ensuring compatibility with the Sphinx build process. This is recommended before building documentation or contributing changes.

```shell
pip install --upgrade -r /requirements.txt
```

--------------------------------

### Import CSV File as Address Book in Zextras

Source: https://github.com/zextras/tech-doc-user/blob/devel/source/carbonio/contacts/toc.rst

Instructions for importing a CSV file into your Zextras web client to create or update an address book. This process requires the CSV file to be formatted correctly with specific column headers. No external libraries are needed, just the CSV file and the Zextras interface.

```text
"company","email","firstName","jobTitle","lastName","middleName","mobilePhone","namePrefix","nickname","workCity","workCountry","workPostalCode","workState","workStreet","workURL"
"ACME","j.doe@example.com","john","CEO","doe","","","","Boss",“Vicenza”,“IT”,“36100”,"","","www.example.com"
"ACME","m.jane@example.com","mary","CFO","jane","","+39 000000000","","MJ",“Vicenza”,“IT”,“36100”,"","","www.example.com"
"ACME","p.sullivan@example.com","Peter","Head of HR","Sullivan","Raymond","","mr","Ray",“Vicenza”,“IT”,“36100”,"","","www.example.com"
"ACME","d.smith@example.com","Donald","CTO","Smith",“”,"","","Don",“Vicenza”,“IT”,“36100”,“”,“”,"www.example.com"
```
Tokens:
Raw