# Console-Docs

**Repository Path**: zjh6/Console-Docs

## Basic Information

- **Project Name**: Console-Docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-01-01
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Windows Console Documentation
Welcome to the Windows Console documentation repo. The MSDN Console Docs are generated from the markdown stored in this repo.

# Metadata
Each content page in this repo requires some metadata expressed as [YAML](https://en.wikipedia.org/wiki/YAML), stored at the top of each doc between '---' markers. For example:

``` markdown
---
title: About Consoles
description: Consoles provide high-level support for simple character-mode applications that interact with the user by using functions that read from standard input and write to standard output or standard error.
author: miniksa
ms.author: miniksa
ms.assetid: 39204f0e-b0b8-4f92-af8e-e146ac06c454
ms.topic: article
---

# About Consoles

Consoles provide high-level support for ...
```
Notes on metadata:
* author: Main article author
* ms.author: Additional co-authors / contributors / editors
* ms.assetid: UUID used by BI for reporting and analysis. Generated by CAPS for existing content, auto-generated by OPS in future
* ms.topic: One of [article | get-started-article | hero-article | hub-page | landing-page | non-content | reference | search] (see [this Excel workbook](https://microsoft.sharepoint.com/teams/STBCSI/Insights/_layouts/15/WopiFrame.aspx?sourcedoc=%7b7A321BF1-0611-4184-84DA-A0E964C435FA%7d&file=WEDCS_MasterList_CSIValues.xlsx&action=default&IsList=1&ListId=%7b46B17C8A-CD7E-47ED-A1B6-F2B654B55E2B%7d&ListItemId=969) for current valid values).

While some metadata is stored per file (e.g. above), common metadata required by all files within a documentation set (docset) is stored in the docfx.json file in the root of the `docs` folder, e.g.:

``` hjson
  "build": {
    #...
    "fileMetadata": {
      "ms.prod": { "/console/**.yml": "windows"},
      "ms.technology": { "/console/**.yml": "desktop"},
      "manager": {"/console/**.yml": "richturn"}
    }
  }
}

```
The values for `ms.prod` and `ms.technology` are standard for Win32 API's & desktop technology, as defined in the Excel workbook above. Custom values can be registered if required.