ይህ ጣቢያ እንዴት እንደሚሰራ

በዲስክ ላይ ያሉ ፋይሎች፣ በዳታቤዝ ውስጥ ያሉ ገጾች፣ እና ከእነሱ የሚቀርበው የሕዝብ ጣቢያ።

ይህ ጣቢያ SmartERP Documentation ሞጁል (smarterp_docs) ነው። ተራ የOdoo ሞጁል ነው፦ ይጫኑት፣ SmartERP መመሪያውን በ/docs ላይ ያቀርባል። የሚፈልገው የOdoo base እና web ብቻ ነው፤ pip install አያስፈልገውም፣ የwebsite ሞጁልም አያስፈልገውም።

መሠረታዊ ሐሳብ#

documentation/en/…md  ─┐
documentation/am/…md  ─┤   install / update /     ┌───────────────┐      ┌──────────────┐
other addons'          ├──► "Sync from Files" ───►│ database      │─────►│ /docs site   │
documentation/ folders ─┘                          │ (sections,    │      │ (public,     │
                                                   │  pages)       │      │  read-only)  │
                        edit in Odoo ─────────────►│               │      └──────────────┘
                                                   └───────────────┘

አዘጋጆች የMarkdown ፋይሎችን ይጽፋሉ፤ ለእያንዳንዱ ገጽ አንድ ፋይል፣ በdocumentation አቃፊ ውስጥ። ፋይሎች እንደ ኮድ ሁሉ በgit ይገመገማሉ፣ ስሪታቸውም ይያዛል።
ሞጁሉ በተጫነ እና በተዘመነ ቁጥር ፋይሎቹ ወደ ዳታቤዙ እንደ ክፍሎች እና ገጾች ይነበባሉ። የምናሌ ንጥል በፈለጉ ጊዜ ተመሳሳዩን ያደርጋል።
ጣቢያው ገጾችን ከዳታቤዙ ወስዶ ያሳያል፣ ስለዚህ በOdoo ውስጥ ማስተካከል ወዲያውኑ ይታያል፤ ፍለጋውም የዳታቤዝ ጥያቄ ነው።

ፋይሎች ወይስ Odoo፣ ምርጫው የእርስዎ ነው#

	ፋይሎችን ማስተካከል	በOdoo ማስተካከል
ተስማሚ ለ	ገንቢዎች፣ ለተገመገሙ ለውጦች፣ ለትርጉም ሥራ	ለፈጣን ማስተካከያ፣ git ለማይጠቀም ሰው
የት	`documentation/<lang>/<section>/<page>.md`	Documentation → Pages
ተፈጻሚ የሚሆነው	ሞጁሉን ካዘመኑ በኋላ ወይም Sync from Files ካደረጉ በኋላ	ወዲያውኑ
ታሪክ	git	የOdoo የመዝገብ ለውጥ ክትትል

እያንዳንዱ ገጽ ከየት እንደመጣ በSource መስኩ ውስጥ ይይዛል፦

Documentation files፦ በእያንዳንዱ ዝመና ከዲስክ ይታደሳል።
Edited in Odoo፦ በባክኤንድ ውስጥ ቀይረውታል፤ ስለዚህ ዝመና ከቶ አይተካውም።

በፋይል ላይ የተመሠረተ ገጽ ርዕስ፣ ጽሑፍ፣ ማጠቃለያ፣ አድራሻ ወይም የመታተም ሁኔታ በOdoo ውስጥ ማስተካከል ገጹን ወደ Edited in Odoo ይቀይረዋል። ቅደም ተከተሉን መቀየር ግን አይቀይረውም። በገጹ ላይ ያለው Reset to File Version የፋይሉን ጽሑፍ መልሶ ያመጣል፤ ገጹንም ከፋይሉ ጋር መልሶ ያያይዘዋል።

በOdoo ውስጥ ያለ ፋይል የፈጠሩት ገጽ በማመሳሰል ፈጽሞ አይነካም። ፋይሉ የተሰረዘ በፋይል ላይ የተመሠረተ ገጽ በሚቀጥለው ማመሳሰል ላይ ይወገዳል፤ ነገር ግን ገጹን ላቀረበው ተጨማሪ ሞጁል (addon) ብቻ ነው፣ እንዲሁም ያ ተጨማሪ ሞጁል አሁንም የመመሪያ አቃፊ ካለው ብቻ ነው። ስለዚህ የጠፋ አቃፊ ጣቢያውን ባዶ ሊያደርግ አይችልም።

እያንዳንዱ ሞጁል የራሱን መመሪያ መያዝ ይችላል#

በእያንዳንዱ ማመሳሰል ወቅት ሞጁሉ በእያንዳንዱ በተጫነ ተጨማሪ ሞጁል ውስጥ የdocumentation አቃፊ ይፈልጋል። ስለዚህ እያንዳንዱ የSmartERP ሞጁል ከኮዱ ጎን የራሱን መመሪያ መያዝ ይችላል፤ ሞጁሉ ሲጫንም በጣቢያው ላይ ይታያል። ለራስዎ ሞጁል መመሪያ ማዘጋጀት ይመልከቱ።

ሚናዎች#

ማን	የሚችለው
ማንኛውም ሰው፣ ማንነታቸው ያልታወቀ ጎብኚዎችንም ጨምሮ	የታተሙ ገጾችን ማንበብ።
Documentation → Editor	መፍጠር፣ ማስተካከል፣ ማተም እና ማተምን ማንሳት። በጣቢያው ላይ ረቂቆችን በምልክት ተለይተው ማየት።

የሲስተም ቅንብሮችን መድረስ የሚችሉ ተጠቃሚዎች በነባሪነት አርታዒ (Editor) ናቸው።

ጎብኚዎች የሚያገኙት#

የክፍሎች መነሻ ገጽ፣ እንዲሁም ሁሉንም ገጾች የያዘ የጎን አሞሌ።
በሚጽፉበት ጊዜ የሚሰራ ፍለጋ፣ እንዲሁም ሙሉ የውጤቶች ገጽ። እያንዳንዱ ቃል መመሳሰል አለበት፤ በርዕስ የተገኘ ተዛማጅ መጀመሪያ ይቀመጣል።
እንግሊዝኛ እና አማርኛ በመቀየሪያ። በአማርኛ ያልተተረጎመ ገጽ የእንግሊዝኛውን ጽሑፍ ከማሳወቂያ ጋር ያሳያል።
በዚህ ገጽ ላይ ዝርዝር፣ የቀዳሚና የቀጣይ ገጽ አገናኞች፣ እና የአሰሳ መንገድ ጠቋሚዎች (breadcrumbs)።
ማስታወሻ ሳጥኖች (callouts)፣ ሠንጠረዦች፣ እና ቅዳ አዝራር ያላቸው የኮድ ብሎኮች።
በላይኛው አሞሌ ባለው መቀየሪያ የሚመርጡት ብርሃን እና ጨለማ ገጽታዎች፦ ብርሃን፣ ራስ-ሰር (የመሣሪያውን ይከተሉ) ወይም ጨለማ። ምርጫዎ በአሳሽዎ ውስጥ ይታወሳል። የማተሚያ ዘይቤዎች፣ እና ለፍለጋ ሞተሮች የሚሆን ሳይትማፕ።
እያንዳንዱ ገጽ ያለ JavaScript ይሰራል።

በፍለጋ ሳጥኑ ውስጥ ሲጽፉ የሚመሳሰሉ ገጾች ወዲያውኑ ይታያሉ። ሙሉውን ዝርዝር ለማየት Enter ን ይጫኑ።

በፍለጋ ሳጥኑ ውስጥ አንድ ቃል ተጽፎ ከስሩ የሚመሳሰሉ ገጾች ዝርዝር ይታያል። — በሚጽፉበት ጊዜ የሚደረግ ፍለጋ።
የሚመሳሰሉ ገጾች ከሳጥኑ ስር ይታያሉ። ሁሉንም ውጤት ለማየት Enter ን ይጫኑ።

በሰፊ ማያ ገጽ ላይ አንድ ገጽ በግራ ክፍሎቹን፣ በመሃል ጽሑፉን፣ በቀኝ ደግሞ በዚህ ገጽ ላይ የሚለውን ዝርዝር ያሳያል።

በግራ የክፍሎች ዝርዝር፣ በመሃል ጽሑፉ፣ በቀኝ ደግሞ «በዚህ ገጽ ላይ» የሚለው ዝርዝር ያለበት የመመሪያ ገጽ። — የመመሪያ ገጽ።
የጎን አሞሌው ሁሉንም ክፍሎች ይዘረዝራል። እያነበቡት ያለው ገጽ ደምቆ ይታያል።
በዚህ ገጽ ላይ፦ በቀጥታ ወደ አንድ ንዑስ ርዕስ ይሂዱ።
የኮድ ብሎኮች የ«ቅዳ» አዝራር አላቸው።

በስልክ ላይ የጎን አሞሌው ወደ ዝርዝር ይቀየራል፤ የፍለጋ ሳጥኑና የገጽታ መቀየሪያው ወደ የላይኛው አሞሌ ሁለተኛ ረድፍ ይሸጋገራሉ። ሌላ ካልመረጡ በቀር ጣቢያው የመሣሪያውን የብርሃን ወይም የጨለማ ቅንብር ይከተላል።

በስልክ ላይ የሚታይ መመሪያ፤ ዝርዝሩ ከገጹ በላይ ተከፍቶ የክፍሎች ዝርዝር ይታያል። — በስልክ ላይ ክፍሎቹ ከዝርዝር አዝራሩ ይከፈታሉ። ጣቢያው የመሣሪያውን የብርሃን ወይም የጨለማ ቅንብር ይከተላል።

የሚታተመው ይዘት ደኅንነት#

አዘጋጅ የሚጽፈው ማንኛውም ነገር ወደ ደኅንነቱ የተጠበቀ ጽሑፍ ይቀየራል (escaped)፦ በMarkdown ፋይል ውስጥ ያለ ጥሬ HTML እንደ ጽሑፍ ይታያል እንጂ በጭራሽ አይሰራም። አገናኞችና ምስሎች ተቀባይነት ባላቸው የአድራሻ ዓይነቶች (schemes) ዝርዝር ላይ ይፈተሻሉ፤ ስለዚህ የjavascript: እና data: አገናኞች ተግባራቸው ይታገዳል። ገጾችን የሚያሳየው ክፍል (renderer) ለእነዚህ ጉዳዮች በትክክል የተዘጋጁ አውቶማቲክ ሙከራዎች አሉት። ለሕዝብ የሚቀርቡት የታተሙ ገጾች ብቻ ናቸው።

በሞጁሉ ውስጥ ነገሮች የት እንዳሉ#

መንገድ	ምንድን ነው
`documentation/`	ገጾቹ፣ በMarkdown።
`lib/mdrender.py`	የMarkdown ገላጭ (renderer)። ከOdoo ምንም አያስመጣም።
`lib/docfiles.py`	የ`documentation` አቃፊዎችን ያነባል። ከOdoo ምንም አያስመጣም።
`lib/ranking.py`	የፍለጋ ውጤት ደረጃ አሰጣጥ። ከOdoo ምንም አያስመጣም።
`lib/amharic.py`	በድምጽ የሚመሳሰሉ የአማርኛ ፊደላትን ያዋህዳል፤ ስለዚህ ማንኛውም ፊደል አጻጻፍ ገጹን ያገኛል። ከOdoo ምንም አያስመጣም።
`lib/assets.py`	ምስሎችን በአሴት መለያ ያስተዳድራል፦ ማኒፌስቱ፣ ምስሎቹ (figures) እና ፍተሻዎቹ። ከOdoo ምንም አያስመጣም።
`models/`	ክፍሎችና ገጾች፣ እንዲሁም ማመሳሰሉ።
`controllers/main.py`	የሕዝብ መንገዶች (routes)።
`views/`	የአርታዒ ማያ ገጾችና የጣቢያው አብነቶች።
`static/img/`, `shots/`	ስክሪንሾቶቹ ከማኒፌስታቸው ጋር፣ እንዲሁም የሚያነሷቸው የሾት ዝርዝሮች።
`static/src/`	የጣቢያው CSS እና JavaScript፣ በእያንዳንዱ ገጽ ውስጥ ተካትተው።
`deploy/`	ለ`doc.smarterp.et` የሆነው የnginx ውቅር።
`tests/`, `tools/`	ሙከራዎች፣ Odoo የማያስፈልገው ማስኬጃ፣ ቀጥታ ቅድመ እይታው እና የስክሪንሾት መሣሪያው።

CSS እና JavaScript በእያንዳንዱ የሰርቨር ሂደት (process) ውስጥ በጊዜያዊ ማከማቻ (cache) ይያዛሉ፤ ስለዚህ ከቀየሯቸው በኋላ Odooን እንደገና ያስጀምሩ።