### Configure MkDocs Environment for Wiki Contribution Source: https://context7.com/forensicswiki/wiki/llms.txt Outlines the setup process for the Forensics Wiki documentation environment using MkDocs. Includes virtual environment creation, dependency installation, and local development server commands. ```bash python3 -m venv mkdocs source mkdocs/bin/activate pip3 install mkdocs-material mkdocs-redirects mkdocs-title-casing-plugin cd wiki mkdocs serve ``` -------------------------------- ### GET af_identify Source: https://github.com/forensicswiki/wiki/blob/main/docs/aff_developers_guide.md Identifies the underlying format of the AFF file handle. ```APIDOC ## GET af_identify ### Description Returns an integer representing the type of file associated with the given handle, such as RAW, AFF, or EWF. ### Method GET ### Parameters #### Request Body - **af** (AFFILE*) - Required - Pointer to the opened AFF file structure. ### Response #### Success Response (200) - **int** - An integer constant representing the file type (e.g., AF_IDENTIFY_AFF, AF_IDENTIFY_RAW). ### Response Example 1 ``` -------------------------------- ### Run mkdocs Development Server Source: https://github.com/forensicswiki/wiki/blob/main/docs/community.md This command starts the local mkdocs development server, which allows you to preview the website at http://127.0.0.1:8000/. ```bash mkdocs serve ``` -------------------------------- ### GET af_get_imagesize Source: https://github.com/forensicswiki/wiki/blob/main/docs/aff_developers_guide.md Retrieves the total size of the decompressed data within the image. ```APIDOC ## GET af_get_imagesize ### Description Returns the number of bytes in the decompressed data. Returns -1 on error. ### Method GET ### Parameters #### Request Body - **af** (AFFILE*) - Required - Pointer to the opened AFF file structure. ### Response #### Success Response (200) - **int64** - The size of the decompressed data in bytes. ### Response Example 1048576 ``` -------------------------------- ### Install mkdocs and Plugins Source: https://github.com/forensicswiki/wiki/blob/main/docs/community.md This command installs mkdocs along with the 'mkdocs-material', 'mkdocs-redirects', and 'mkdocs-title-casing-plugin' plugins using pip. ```bash pip3 install mkdocs-material mkdocs-redirects mkdocs-title-casing-plugin ``` -------------------------------- ### Example Tagging for Windows Article Source: https://github.com/forensicswiki/wiki/blob/main/docs/community.md This example demonstrates how to tag an article about the Windows operating system. It includes the general 'Operating System' tag and the specific 'Windows' tag. ```text --- tags: - Operating System - Windows --- ``` -------------------------------- ### GET af_filename Source: https://github.com/forensicswiki/wiki/blob/main/docs/aff_developers_guide.md Retrieves the filename associated with an opened AFF file handle. ```APIDOC ## GET af_filename ### Description Returns the filename string associated with the provided AFFILE handle. ### Method GET ### Parameters #### Request Body - **af** (AFFILE*) - Required - Pointer to the opened AFF file structure. ### Response #### Success Response (200) - **string** - The filename associated with the file handle. ### Response Example "/path/to/image.aff" ``` -------------------------------- ### Get AFF Filename Source: https://github.com/forensicswiki/wiki/blob/main/docs/aff_developers_guide.md Retrieves the filename associated with an opened AFF file handle. This function is useful for logging or displaying the current file being processed. ```c const char * af_filename(AFFILE *af); printf ("The current file being read is %s.\n", af_filename(af)); ```