ገጾችን መጻፍ · የSmartERP መመሪያ

የፋይል አቀማመጥ፣ የፋይል ራስጌ (front matter) እና መጠቀም የሚችሉት Markdown፣ ከእያንዳንዳቸው ምሳሌ ጋር።

አንድ ገጽ የሚገኝበት ቦታ#

documentation/
  en/
    20-getting-started/
      _section.md
      10-install-with-docker.md
      20-first-login.md
  am/
    20-getting-started/
      _section.md
      10-install-with-docker.md

የመጀመሪያው አቃፊ ቋንቋ ነው፦ en ወይም am።
ሁለተኛው ክፍል ነው። የክፍሉ ርዕስ እና ማጠቃለያ በ_section.md ፋይሉ ይሰጣል።
ሌላ እያንዳንዱ .md ፋይል ገጽ ነው።
የአንድ ገጽ የአማርኛ ስሪት በam/ ስር ተመሳሳይ መንገድ አለው።

እንደ 20- ወይም 10- ያለ መጀመሪያ ላይ የሚገኝ ቁጥር ነገሮችን ቅደም ተከተል ያስይዛል እንጂ የአድራሻው አካል አይደለም። ከላይ ያለው ገጽ የሚገኘው በ/docs/en/getting-started/install-with-docker ላይ ነው።

አድራሻዎች (slugs)#

አድራሻው የሚመጣው ከፋይሉ ወይም ከአቃፊው ስም ነው፣ ከማንኛውም ቁጥር በኋላ ካለው ክፍል። ትናንሽ (lower-case) ፊደላትን፣ አኃዞችንና ነጠላ ሰረዞችን (hyphens) ይጠቀሙ፦ install-with-docker። እነዚህ ስሞች የተጠበቁ ናቸው፤ መጠቀም አይቻልም፦ search፣ sitemap፣ robots፣ static። ክፍል ደግሞ p ተብሎ ሊጠራ አይችልም። ደንቡን የሚጥስ ፋይል ይዘለላል፤ በሰርቨሩ መዝገብ (log) ውስጥም ሪፖርት ይደረጋል፤ ሞጁሉ እንዳይዘምን ግን ፈጽሞ አያግደውም።

የፋይል ራስጌ (front matter)#

አንድ ገጽ በሁለት --- መስመሮች መካከል በሚገኝ ትንሽ ክፍል ሊጀምር ይችላል፦

---
title: Install with Docker
summary: A self-contained stack on port 8291.
sequence: 10
published: true
---

ቁልፍ	ትርጉም	ከሌለ
`title`	የገጹ ርዕስ።	በፋይሉ ውስጥ ያለው የመጀመሪያው `# Heading`፣ ካልሆነ የፋይሉ ስም።
`summary`	ከርዕሱ ስር፣ በክፍሉ ማውጫ ውስጥ እና በፍለጋ ውጤቶች ውስጥ የሚታይ አንድ መስመር።	የለም
`sequence`	የመደርደሪያ ቅደም ተከተል።	በፋይሉ ስም ውስጥ ያለው ቁጥር፣ ካልሆነ በፊደል ተራ።
`published`	`false` ገጹን እንደ ረቂቅ ያቆየዋል።	`true`
`product`	ገጹ ስለ እርሱ የሆነው ምርት ወይም ሞጁል አድራሻ።	የክፍሉ ምርት፣ ከዚያ ነባሪው ምርት።
`type`	የይዘት አይነት፦ `overview`፣ `concept`፣ `how_to`፣ `tutorial`፣ `reference`፣ `faq`፣ `troubleshooting` እና በገጽ ቅጹ ውስጥ ያሉት ሌሎች።	የለም
`difficulty`	`beginner`፣ `intermediate` ወይም `advanced`።	የለም
`audience`፣ `industry`፣ `tags`	በነጠላ ሰረዝ የተለዩ ስሞች ወይም አድራሻዎች። የሌለ መለያ ይፈጠራል።	የለም
`versions`	ገጹ እውነት የሆነባቸው በነጠላ ሰረዝ የተለዩ የምርት ስሪቶች።	ሁሉም
`visibility`	`public`፣ `customer`፣ `partner` ወይም `internal`።	`public`
`review`	ገጹን እንደገና የሚያነቡበት ቀን፣ ለምሳሌ `2027-06-30`።	ሲታተም ይቀመጣል
`owner`	ለገጹ ኃላፊነት ያለው ሰው የመግቢያ ስም።	የለም
`prerequisites`፣ `result`	እያንዳንዳቸው አንድ መስመር፦ አንባቢው የሚፈልገው፣ እና የሚያገኘው።	የለም

ይህ ሙሉ YAML አይደለም፦ ቀላል key: value መስመሮች ብቻ ናቸው። እሴቱ ኮሎን (colon) ካለው በዙሪያው ጥቅሶችን ያድርጉ።

የክፍል _section.md title፣ summary እና sequence ይቀበላል፤ እንዲሁም product፣ visibility፣ kind (ክፍሉ የትኛው የመመሪያ ክፍል እንደሆነ፣ ለምሳሌ getting_started፣ user_guide ወይም troubleshooting፤ ሽፋን የሚቆጥረው ይህን ነው) እና parent (ክፍሉን በሥሩ ለማስቀመጥ የክፍል አድራሻ)። ልክ ያልሆነ እሴት ችላ ይባልና በአገልጋዩ መዝገብ ውስጥ ይዘገባል፤ ዝመናውን በጭራሽ አያቆምም።

የመጀመሪያ መስመር ላይ ያለ # Title እንደ ርዕስ ያገለግላል፤ ጣቢያው ራሱ ርዕሱን ስለሚያትም ከጽሑፉ ይወገዳል። ንዑስ ርዕሶችዎን ከ## ይጀምሩ።

መጠቀም የሚችሉት Markdown#

## A section heading
### A sub-section

Plain paragraphs, with **bold**, *italic*, ~~strikethrough~~ and `inline code`.

- A bullet list
  - with a nested item
1. A numbered list
2. Second step

[An external link](https://n8n.io) and [a page in these docs](doc:administration/troubleshooting)

| Column | Other column |
|---|---|
| a cell | another cell |

> A quotation

---

ከላይ ያለው ሁሉ በጣቢያው ይቀርባል። ንዑስ ርዕሶች አገናኝ ሊደረግባቸው የሚችል አድራሻ ያገኛሉ፤ እንዲሁም በዚህ ገጽ ላይ በሚለው ዝርዝር ውስጥ ይካተታሉ።

ቋሚ የንዑስ ርዕስ አድራሻዎች#

የንዑስ ርዕስ አድራሻ በመደበኛነት የሚመጣው ከቃላቱ ነው፤ ስለዚህ ቃላቱን መቀየር አድራሻውን ይቀይረዋል፣ የተተረጎመ ንዑስ ርዕስም የተለየ አድራሻ ያገኛል። አድራሻው እንዳይለወጥ በንዑስ ርዕሱ መጨረሻ ላይ ግልጽ አድራሻ ያስቀምጡ፦

## Guardrails {#guardrails}

የ{#guardrails} ክፍል አይታይም። ሌሎች ገጾች አገናኝ በሚያደርጉበት በማንኛውም ንዑስ ርዕስ ላይ ይጠቀሙት፤ በእንግሊዝኛውና በአማርኛው ስሪቶች ውስጥ ተመሳሳይ አድራሻ ይስጡ፤ በዚህም እንደ doc:ai-workforce/autonomy-levels#guardrails ያለ አገናኝ በሁለቱም ይሰራል።

በገጾች መካከል ያሉ አገናኞች#

የአንባቢውን ቋንቋና የጣቢያውን አድራሻ የሚከተለውን የdoc: ቅጽ ይጠቀሙ፦

እርስዎ የሚጽፉት	የሚያገናኘው
`[Troubleshooting](doc:administration/troubleshooting)`	ወደዚያ ገጽ
`[Administration](doc:administration)`	ወደዚያ ክፍል
`[A heading](doc:administration/troubleshooting#installing)`	በዚያ ገጽ ላይ ወዳለ ንዑስ ርዕስ

ተራ የhttps:// አገናኞች በአዲስ ትር ይከፈታሉ።

የኮድ ብሎኮች#

ሦስት የኋላ ጥቅስ ምልክቶችን (backticks) እና ከፈለጉ ቋንቋውን ያስቀምጡ፦

```bash
cd deploy && ./start.sh
```

በውስጥ ያለ ምንም ነገር አይተረጎምም። አንባቢዎች ቅዳ አዝራር ያገኛሉ።

ሠንጠረዦች#

የቧንቧ ምልክት (pipe) ሠንጠረዦች፤ በመለያ መስመሩ ውስጥ በኮሎኖች አማራጭ አሰላለፍ ማድረግ ይቻላል፦

| Left | Right |
|:--|--:|
| a | 1 |

በሕዋስ ውስጥ ያለ ቀጥተኛ | የሚጻፈው \| ተብሎ ነው።

ማስታወሻ ሳጥኖች (Callouts)#

ጥቅስን በካሬ ቅንፍ ውስጥ በሚገኝ ምልክት ይጀምሩ፦

> [!NOTE]
> Something worth knowing.

> [!WARNING] Back up first
> A custom title goes after the marker.

ምልክት	የሚጠቅምበት
`[!NOTE]`	ተጨማሪ መረጃ።
`[!TIP]`	ነገሩን ለማድረግ የተሻለ መንገድ።
`[!IMPORTANT]`	አንባቢው ሊያመልጠው የማይገባ ነገር።
`[!WARNING]`	ሊሳሳት የሚችል ነገር።
`[!CAUTION]`	ጉዳት ወይም ዳታ መጥፋት ሊያስከትል የሚችል ነገር።

ነባሪው ርዕስ የእንግሊዝኛው ቃል ነው። በአማርኛ ገጽ ውስጥ ከምልክቱ በኋላ የአማርኛ ርዕስ ይስጡ።

የጥንቃቄ ማስታወሻ ሳጥን እንዲህ ይመስላል፦

የመረጃ መጥፋትን የሚያስጠነቅቅ ቀይ የጥንቃቄ ሳጥን። — የጥንቃቄ ማስታወሻ ሳጥን። ማስታወሻ ሳጥኖች አምስት ዓይነት ናቸው፦ ማስታወሻ፣ ጠቃሚ ምክር፣ አስፈላጊ፣ ማስጠንቀቂያ እና ጥንቃቄ።

ምስሎች#

ስክሪንሾትን በአሴት መለያው (asset id) ያሳዩ፤ በራሱ መስመር ላይ፦

![Search as you type]({asset:docs-search})

ጣቢያው ለአንባቢው ቋንቋ የሚሆነውን ምስል፣ የጨለማ ስሪት ካለም እሱን ይመርጣል። አማራጭ ጽሑፉ (alt) እና መግለጫው ከምስሉ መዝገብ በሁለቱም ቋንቋዎች ይመጣሉ። ስክሪንሾቶችን ለመሥራት ስክሪንሾቶች ን ይመልከቱ።

ተራ ምስል አሁንም ይሰራል፤ ለምሳሌ ሌላ ቦታ የተስተናገደ፦

![Logo](https://example.com/logo.png "Title")

የሚፈቀዱት http፣ https እና አንጻራዊ (relative) ወይም ከመነሻው (root) የሚጀምሩ አድራሻዎች ብቻ ናቸው። የአሴት መለያዎችን ይምረጡ፦ በሁለቱም ቋንቋዎች አማራጭ ጽሑፍ ይዘዋል፤ ፍተሻዎቹም ያረጋግጧቸዋል።

የማይደገፈው#

ጣቢያው ደኅንነቱ የተጠበቀና ቀላል እንዲሆን፦

ጥሬ HTML እንደ ጽሑፍ ይታያል እንጂ አይሰራም።
የግርጌ ማስታወሻዎች፣ የተግባር ዝርዝሮች (task lists)፣ የትርጓሜ ዝርዝሮች (definition lists) ወይም setext (የተሰመረባቸው) ንዑስ ርዕሶች አይደገፉም።
የjavascript: ወይም data: አገናኞች አይፈቀዱም። በ# ይተካሉ።

ቅድመ እይታ#

በራስዎ ኮምፒውተር ላይ፣ ያለ Odoo#

Python 3 ብቻ ያስፈልግዎታል። smarterp_docs ከያዘው አቃፊ ውስጥ፦

python3 smarterp_docs/tools/preview.py --open

አሳሽዎ ጣቢያውን በhttp://127.0.0.1:8300/docs ይከፍታል። የ.md ፋይል ያስተካክሉ፣ ያስቀምጡ፣ እና አሳሹን ያድሱ፦ እንደገና ማስጀመር አያስፈልግም። published: false ተብለው የተመለከቱ ገጾችን በረቂቅ ምልክት ተለይተው ለማየት --editor ይጨምሩ። 8300 ከተያዘ --port ይጠቀሙ፤ ሌላ የሰነድ አቃፊ ለማየት ደግሞ --docs ይጠቀሙ።

ቅድመ እይታው ከእውነተኛው ጣቢያ ጋር ተመሳሳይ የገጽ አብነቶችን፣ ስታይሎችን፣ ፎንቶችን፣ ፍለጋንና የMarkdown አቀናባሪን ይጠቀማል፤ ስለዚህ ገጾች ተመሳሳይ ሆነው ይታያሉ፣ በተመሳሳይ መንገድም ይፈለጋሉ። የOdoo የጀርባ ቢሮ፣ መግቢያዎች ወይም ዳታቤዝ የለውም፤ ይዘት ለመጻፍና ለመፈተሽ ይጠቀሙበት።

በOdoo ውስጥ#

በOdoo ማስተካከል፦ በDocumentation → Pages ውስጥ ገጹን ይክፈቱ እና View on Site ን ይጫኑ። ያልታተሙ ገጾች ለእርስዎ በረቂቅ ምልክት ተለይተው ይታያሉ።
ፋይሎችን ማስተካከል፦ ሞጁሉን ያዘምኑ (ወይም Documentation → Sync from Files ን ይጠቀሙ) እና ገጹን ያድሱ።

ጥሩ ልማድ፦ ገጹን በሁለቱም ቋንቋዎች ያንብቡ፤ አንባቢ እንደሚያገኘውም ለማረጋገጥ የጣቢያውን ፍለጋ ይጠቀሙ።