ለራስዎ ሞጁል መመሪያ ማዘጋጀት

እያንዳንዱን ገጽ በsmarterp_docs ውስጥ ማስቀመጥ አያስፈልግዎትም። ማንኛውም የOdoo ተጨማሪ ሞጁል (addon) የራሱን መመሪያ ሊይዝ ይችላል፤ ይህ ጣቢያም ይወስደዋል።

የአሰራር ደንቡ#

ልክ እንደዚህ ሞጁል አቀማመጥ ያለው የdocumentation አቃፊ ወደ ተጨማሪ ሞጁልዎ ያክሉ፦

my_module/
  __manifest__.py
  models/ …
  documentation/
    en/
      45-my-area/
        _section.md
        10-overview.md
        20-how-to-do-x.md
    am/
      45-my-area/
        _section.md
        10-overview.md

ገጾቹን በገጾችን መጻፍ ላይ እንደተገለጸው ይጻፉ።

መቼ እንደሚወሰድ#

መመሪያው በሚመሳሰልበት ጊዜ ሁሉ፦

• smarterp_docs ሲጫን ወይም ሲዘምን፤
• አንድ ሰው Documentation → Sync from Files ን ሲጫን።

የሚቃኙት የተጫኑ ተጨማሪ ሞጁሎች ብቻ ናቸው፤ ስለዚህ የአንድ ሞጁል መመሪያ የሚታየው ያ ሞጁል ሲጫን ነው። አዲስ ሞጁል ከጫኑ በኋላ Sync from Files ን ይጫኑ።

ክፍሎችና ገጾች በአድራሻ ይጋራሉ#

የክፍል አድራሻ (slug) ለሁሉም የጋራ ነው (global)። ይህ ሁለት ምርጫዎችን ይሰጥዎታል፦

• የራስዎ ክፍል። እንደ my-area ያለ አዲስ አድራሻ ይምረጡ እና _section.md ያካትቱ። ክፍሉና ገጾቹ የተጨማሪ ሞጁልዎ ናቸው።
• ወደ ነባር ክፍል ማከል። ከነባር ክፍል ጋር ተመሳሳይ የክፍል አቃፊ ስም (ለምሳሌ administration) ይጠቀሙ እና _section.md ን አያካትቱ። ገጾችዎ ክፍሉን ይቀላቀላሉ፤ የክፍሉ ርዕስ፣ ማጠቃለያ እና ቦታ እንዳሉ ይቆያሉ። አቃፊዎ _section.md ካካተተ ያ ፋይል የክፍሉን ርዕስ፣ ማጠቃለያ እና ቦታ ይተካል፤ ስለዚህ ማድረግ ሲፈልጉ ብቻ ያካትቱት።

ገጾች የሚዛመዱት በክፍልና በገጽ አድራሻ ነው። ሁለት ተጨማሪ ሞጁሎች ተመሳሳይ ገጽ ካዘጋጁ፣ ለምሳሌ administration/troubleshooting፣ በመጨረሻ የተመሳሰለው ተጨማሪ ሞጁል ያለ ምንም ማሳወቂያ ያሸንፋል። ይህ ሞጁል መጀመሪያ ይሄዳል፤ ከዚያ ሌሎቹ በፊደል ተራ ይከተላሉ። ይህን ለማስቀረት ገጾችዎን በሞጁልዎ ዘርፍ ስም ይሰይሙ።

ክፍልዎን ከሌሎች ክፍሎች መካከል ለማስቀመጥ እንደ 45- ያለውን በአቃፊው ስም ውስጥ ያለ ቁጥር ይጠቀሙ።

መመሪያን ማስወገድ#

የአንድ ገጽ ፋይል ሲጠፋ ገጹ በሚቀጥለው ማመሳሰል ላይ ይወገዳል፤ የሚወገደውም ከዚያ ተጨማሪ ሞጁል አቃፊ የመጣ ከሆነ ብቻ ነው። አንድ ተጨማሪ ሞጁል ሲራገፍ ገጾቹ አቃፊው ከተጨማሪ ሞጁሎች መንገድ (addons path) እስኪጠፋና ማመሳሰል እስኪሰራ ድረስ ይቆያሉ። በOdoo ውስጥ የጻፏቸው ወይም ያስተካከሏቸው ገጾች ፈጽሞ አይወገዱም።

ከማንኛውም ተጨማሪ ሞጁል ውጭ ያለ መመሪያ#

በተጨማሪ ሞጁል ውስጥ የማይገኝ አቃፊን ለመጫን፣ ለምሳሌ በሰርቨሩ ላይ የወረደ የተለየ የመመሪያ ማከማቻ (repository)፣ የሲስተም ግቤቱን ያዘጋጁ፦

እያንዳንዱ አቃፊ ተመሳሳይ የen/… እና am/… አቀማመጥ ሊኖረው ይገባል።

ሞጁልን ለመመዝገብ የማረጋገጫ ዝርዝር#

• ባለ አንድ መስመር ማጠቃለያ ያለው ክፍል።
• አጠቃላይ እይታ፦ ለምን እንደሆነና ማን እንደሚጠቀመው።
• እንዴት እንደሚጫንና ምን እንደሚያስፈልገው።
• ተጠቃሚው ለሚያከናውነው ለእያንዳንዱ ተግባር አንድ ገጽ፣ በአዝራሮቹ ላይ ያሉትን መለያዎች በመጠቀም።
• ሚናዎች፦ ማን ምን ማድረግ ይችላል።
• ቅንብሮችና የታቀዱ ተግባራት።
• የስህተት መልዕክቶችን ትክክለኛ ጽሑፍ የያዘ የችግር መፍቻ።
• የሞዴሎችና የመንገዶች (routes) ማጣቀሻ።
• አማርኛ አቀላጥፎ በሚያውቅ አንባቢ የተገመገመ የአማርኛ ስሪት።