Commit 18f52b0d authored by Danir Tlepov's avatar Danir Tlepov

Added itsm_spec document

parent 018f502b
......@@ -30,6 +30,7 @@ hrm/developer-manual
hrm/spec
hrm/user-manual
hrm/additional
itsm/spec
"
FULL_DOC_DIRS="
......@@ -50,6 +51,7 @@ ADDITIONAL_TARGETS["crm/spec"]="html pdf docx"
ADDITIONAL_TARGETS["hrm/developer-manual"]="html pdf"
ADDITIONAL_TARGETS["hrm/user-manual"]="html pdf"
ADDITIONAL_TARGETS["hrm/spec"]="html pdf docx"
ADDITIONAL_TARGETS["itsm/spec"]="html pdf docx"
## END CONFIG SECTION
......
# Генератор документации
SRC=src
DOCBOOK-XSL = /usr/share/xml/docbook/stylesheet/docbook-xsl
DOCBOOKOPTS=--template=conf/pandoc/book.docbook --smart -t docbook -V lang=ru
ODTOPTS=-t odt --standalone
PANDOC_PDF_OPTIONS=--latex-engine=xelatex \
--template=conf/pandoc/template.latex \
-V lang=$(LANGUAGE) \
-V papersize:"a4paper" \
-V geometry:margin=2cm \
-V mainfont="Liberation Serif" \
-V sansfont="Liberation Sans" \
-V classoption=11pt \
--smart \
--no-tex-ligatures
# --highlight-style=kate \
# -V classoption=12pt \
spec.md:
gpp -H -I$(SRC) $(SRC)/index.md > spec.md
spec.xml: spec.md
@echo Creating full XML image
ifdef VCSREV
pandoc $(DOCBOOKOPTS) spec.md \
| xsltproc --encoding utf8 \
--stringparam vcs.revision $(VCSREV) \
--stringparam vcs.changedby "$(VCSCHANGEDBY)" \
--xinclude conf/vcs/insert-revision-and-build-date.xsl - > spec.xml
else
pandoc $(DOCBOOKOPTS) spec.md -o spec.xml
#SP_ENCODING="UTF-8" xmllint --encode utf8 --xinclude src/index.xml > spec.xml
endif
sed -i 's/xml:base=".*"//g' spec.xml
html: spec.xml
@echo Creating html document
rm -rf bin/html
mkdir bin/html
LC_ALL=en_US.UTF-8 xmlto xhtml -m conf/html/settings.xsl -o bin/html spec.xml
tar --exclude-vcs -c resources | tar x -C bin/html
# Working around images used in stylesheets
mkdir bin/html/resources/docbook
cp -a $(DOCBOOK-XSL)/images bin/html/resources/docbook
pdf: spec.md
@echo Creating pdf document
mkdir -p bin/pdf
# SP_ENCODING="UTF-8" docbook2pdf -o bin spec.xml
pandoc $(PANDOC_PDF_OPTIONS) -o bin/pdf/spec.pdf spec.md
odt-ru: spec.md
[ -d bin/odt ] || mkdir bin/odt
pandoc $(ODTOPTS) -o bin/odt/spec.odt spec.md
odt: odt-ru
rm -f spec.md
docx: spec.md
mkdir -p bin/docx
pandoc -s -S -o bin/docx/spec.docx spec.md
clean:
@echo Remove all
rm -rf *.xml *.md bin/*
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'>
<xsl:output encoding="UTF-8" indent="yes"/>
<xsl:param name="use.id.as.filename" select="1"/>
<xsl:param name="generate.revhistory.link" select="1"/>
<xsl:param name="toc.section.depth" select="6"/>
</xsl:stylesheet>
<?xml version="1.0" encoding="utf-8" ?>
$if(mathml)$
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook EBNF Module V1.1CR1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
$else$
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
$endif$
$if(lang)$
<book lang="$lang$">
$else$
<book>
$endif$
<bookinfo>
<title>$title$</title>
$for(author)$
<author>
$author$
</author>
$endfor$
$if(subtitle)$
<subtitle>$subtitle$</subtitle>
$endif$
$if(date)$
<date>$date$</date>
$endif$
$if(copyright)$
<legalnotice>
<para>$copyright$</para>
</legalnotice>
$endif$
</bookinfo>
$for(include-before)$
$include-before$
$endfor$
$body$
$for(include-after)$
$include-after$
$endfor$
</book>
\documentclass[$if(fontsize)$$fontsize$,$endif$$if(lang)$$lang$,$endif$$if(papersize)$$papersize$,$endif$$for(classoption)$$classoption$$sep$,$endfor$]{$documentclass$}
% Add possibility to make image on separate landscape page
\usepackage{pdflscape}
\usepackage{rotating}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{amssymb,amsmath}
\usepackage{ifxetex,ifluatex}
\usepackage{fixltx2e} % provides \textsubscript
% use upquote if available, for straight quotes in verbatim environments
\IfFileExists{upquote.sty}{\usepackage{upquote}}{}
\ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex
\usepackage[utf8]{inputenc}
$if(euro)$
\usepackage{eurosym}
$endif$
\else % if luatex or xelatex
\ifxetex
\usepackage{mathspec}
\usepackage{xltxtra,xunicode}
% Use fontspec on XeTeX too
\usepackage{fontspec}
% Set default fonts if not submitted
$if(mainfont)$
\setmainfont{$mainfont$}
$else$
\setmainfont{DejaVu Serif}
$endif$
$if(sansfont)$
\setsansfont{$sansfont$}
$else$
\setsansfont{DejaVu Sans}
$endif$
$if(monofont)$
\setmonofont[Mapping=tex-ansi]{$monofont$}
$else$
\setmonofont{DejaVu Sans Mono}
$endif$
$if(mathfont)$
\setmathfont(Digits,Latin,Greek){$mathfont$}
$endif$
\else
\usepackage{fontspec}
\fi
\defaultfontfeatures{Mapping=tex-text,Scale=MatchLowercase}
\newcommand{\euro}{}
\fi
% use microtype if available
\IfFileExists{microtype.sty}{\usepackage{microtype}}{}
$if(geometry)$
\usepackage[$for(geometry)$$geometry$$sep$,$endfor$]{geometry}
$else$
\usepackage{geometry}
$endif$
$if(natbib)$
\usepackage{natbib}
\bibliographystyle{$if(biblio-style)$$biblio-style$$else$plainnat$endif$}
$endif$
$if(biblatex)$
\usepackage{biblatex}
$if(biblio-files)$
\bibliography{$biblio-files$}
$endif$
$endif$
$if(listings)$
\usepackage{listings}
$endif$
$if(lhs)$
\lstnewenvironment{code}{\lstset{language=Haskell,basicstyle=\small\ttfamily}}{}
$endif$
$if(highlighting-macros)$
$highlighting-macros$
$endif$
$if(verbatim-in-note)$
\usepackage{fancyvrb}
$endif$
$if(tables)$
\usepackage{longtable,booktabs}
$endif$
$if(graphics)$
\usepackage{graphicx}
% Redefine \includegraphics so that, unless explicit options are
% given, the image width will not exceed the width of the page.
% Images get their normal width if they fit onto the page, but
% are scaled down if they would overflow the margins.
\makeatletter
\def\ScaleIfNeeded{%
\ifdim\Gin@nat@width>\linewidth
\linewidth
\else
\Gin@nat@width
\fi
}
\makeatother
\let\Oldincludegraphics\includegraphics
{%
\catcode`\@=11\relax%
\gdef\includegraphics{\@ifnextchar[{\Oldincludegraphics}{\Oldincludegraphics[width=\ScaleIfNeeded]}}%
}%
$endif$
\ifxetex
$if(docbookstyle)$
\usepackage[hyperlink]{docbook}
$else$
\usepackage[setpagesize=false, % page size defined by xetex
unicode=false, % unicode breaks when used with xetex
xetex]{hyperref}
$endif$
\else
\usepackage[unicode=true]{hyperref}
\fi
\hypersetup{breaklinks=true,
bookmarks=true,
pdfauthor={$author-meta$},
pdftitle={$title-meta$},
colorlinks=true,
citecolor=$if(citecolor)$$citecolor$$else$blue$endif$,
urlcolor=$if(urlcolor)$$urlcolor$$else$blue$endif$,
linkcolor=$if(linkcolor)$$linkcolor$$else$magenta$endif$,
pdfborder={0 0 0}}
\urlstyle{same} % don't use monospace font for urls
$if(links-as-notes)$
% Make links footnotes instead of hotlinks:
\renewcommand{\href}[2]{#2\footnote{\url{#1}}}
$endif$
$if(strikeout)$
\usepackage[normalem]{ulem}
% avoid problems with \sout in headers with hyperref:
\pdfstringdefDisableCommands{\renewcommand{\sout}{}}
$endif$
\setlength{\parindent}{0pt}
\setlength{\parskip}{6pt plus 2pt minus 1pt}
\setlength{\emergencystretch}{3em} % prevent overfull lines
$if(numbersections)$
\setcounter{secnumdepth}{5}
$else$
\setcounter{secnumdepth}{0}
$endif$
$if(verbatim-in-note)$
\VerbatimFootnotes % allows verbatim text in footnotes
$endif$
% Our special commands
\newcommand{\lscapefigure}{\newgeometry{margin=1cm}\begin{landscape}\thispagestyle{empty}}
\newcommand{\nolscapefigure}{\end{landscape}\restoregeometry}
$if(lang)$
\ifxetex
\usepackage{polyglossia}
\setmainlanguage{$mainlang$}
\else
\usepackage[$lang$]{babel}
\fi
$endif$
% Fix \tightlist (https://github.com/jgm/pandoc/pull/1571#issuecomment-106298268)
\providecommand{\tightlist}{%
\setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}
$if(title)$
\title{$title$}
$endif$
\author{$for(author)$$author$$sep$ \and $endfor$}
\date{$date$}
$for(header-includes)$
$header-includes$
$endfor$
\begin{document}
$if(title)$
\maketitle
$endif$
$if(subtitle)$
%\makesubtitle
%\begin{subtitle}
$subtitle$
%\end{subtitle}
$endif$
$if(copyright)$
\begin{copyright}
$copyright$
\end{copyright}
$endif$
$if(abstract)$
\begin{abstract}
$abstract$
\end{abstract}
$endif$
$for(include-before)$
$include-before$
$endfor$
$if(toc)$
{
%\hypersetup{linkcolor=black}
\setcounter{tocdepth}{$toc-depth$}
\tableofcontents
}
$endif$
$if(listoffigures)$
\listoffigures
\clearpage
$endif$
$body$
$if(natbib)$
$if(biblio-files)$
$if(biblio-title)$
$if(book-class)$
\renewcommand\bibname{$biblio-title$}
$else$
\renewcommand\refname{$biblio-title$}
$endif$
$endif$
\bibliography{$biblio-files$}
$endif$
$endif$
$if(biblatex)$
\printbibliography$if(biblio-title)$[title=$biblio-title$]$endif$
$endif$
$for(include-after)$
$include-after$
$endfor$
\end{document}
<?xml version="1.0"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output
indent="yes"
doctype-system="http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
doctype-public="-//OASIS//DTD DocBook XML V4.4//EN"/>
<!-- Copy all -->
<xsl:template match="@*|node()">
<xsl:copy>
<xsl:apply-templates select="@*|node()"/>
</xsl:copy>
</xsl:template>
<!-- Add releaseinfo if not present -->
<!-- Maybe we should explictly replace it?
It seems we have to
add another template in that case -->
<xsl:template match="/book/bookinfo[not(pubdate)][not(releaseinfo)]">
<xsl:copy>
<xsl:apply-templates select="@*"/>
<pubdate>Дата сборки документа:
<xsl:processing-instruction name="dbtimestamp">
format="Y.m.d H:M:S"
</xsl:processing-instruction>
</pubdate>
<releaseinfo>Ревизия VCS: <xsl:value-of select="$vcs.revision" /></releaseinfo>
<releaseinfo>Последним изменил: <xsl:value-of select="$vcs.changedby" /></releaseinfo>
<xsl:apply-templates select="node()"/>
</xsl:copy>
</xsl:template>
<!-- Deal with chapters -->
<xsl:template match="/book/chapter[not(chapterinfo)]">
<xsl:copy>
<xsl:apply-templates select="@*"/>
<chapterinfo>
<pubdate>Дата сборки документа:
<xsl:processing-instruction name="dbtimestamp">
format="Y.m.d H:M:S"
</xsl:processing-instruction>
</pubdate>
<releaseinfo>Ревизия VCS: <xsl:value-of select="$vcs.revision" /></releaseinfo>
</chapterinfo>
<xsl:apply-templates select="node()"/>
</xsl:copy>
</xsl:template>
<!-- Deal with sections -->
<xsl:template match="/book/chapter/section[not(sectioninfo)]">
<xsl:copy>
<xsl:apply-templates select="@*"/>
<sectioninfo>
<pubdate>Дата сборки документа:
<xsl:processing-instruction name="dbtimestamp">
format="Y.m.d H:M:S"
</xsl:processing-instruction>
</pubdate>
<releaseinfo>Ревизия VCS: <xsl:value-of select="$vcs.revision" /></releaseinfo>
</sectioninfo>
<xsl:apply-templates select="node()"/>
</xsl:copy>
</xsl:template>
</xsl:stylesheet>
---
author:
- Данир Тлепов
- Елизавета Каховская
title: Спецификация ITSM
subtitle: Версия 0.1
...
<#include "itsm_spec.md">
### Общие сведения {#overview}
Synergy CRM устанавливается отдельным пакетом. Возможные варианты установки:
1. Clean CRM - установка конфигурации CRM без данных (чистая установка с загрузка
преднастроенной БД и хранилища Synergy)
2. Demo CRM - установка конфигурации CRM с демо-данными (с загрузкой преднастроенной
БД и хранилища Synergy с демонстрационными данными)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment