jorgeescallon / liferay-docs Goto Github PK
View Code? Open in Web Editor NEWThis project forked from liferay/liferay-docs
License: Other
This project forked from liferay/liferay-docs
License: Other
Documentation Repository Contents ================================= This repository is intended for storage of Liferay product documentation. Documents are to be comprised of chapter source files in Markdown format. Images referenced in the documents are to be stored in the appropriate images directories. Document sources are stored in directories for their appropriate language (e.g. 'en' for English). Directory Structure =================== liferay-docs/ |____ <document dir>/ (e.g. QuickstartGuide/, userGuide/, devGuide/, soffice/) | |____ <language dir>/ (e.g. 'en' for English, 'es' for Spanish) | | | | | |____ chapters/ | | | |____ [0-9][0-9]-<chapter subject>.markdown | | | (e.g. 01-intro.markdown) | | | | | |____ images/ (language specific versions of the default images) | | | |____ images/ (default images for the document) | |____ build.xml | |____ code/ (code for custom ant tasks) |____ lib/ (JARs for custom ant tasks) | |____ README |____ build-common.xml |____ build.properties |____ liferay-book-template.ott |____ liferay-book-template-tradepaperback.ott Document Format Conversion ========================== Documents can be converted from markdown to HTML, epub and ODT formats using ant targets found in build-common.xml. Override default properties, found in build.properties, by creating your own properties file (e.g. build.<username>.properties) to specify your desired property values. The conversion targets create a build directory (e.g. userGuide/build/) for the current document. This directory receives the Markdown source file, the language specific image files, and the converted document. Required Software ----------------- * Ant: Required for executing Ant targets. Download from ... http://ant.apache.org/bindownload.cgi * Pandoc: Used in our Ant targets for conversions from Markdown to various formats. See installation instructions at ... http://johnmacfarlane.net/pandoc/installing.html Conversion Steps ---------------- 1. Go to the directory of the document to be converted. Example - userGuide, cd liferay-docs/userGuide 2. Execute a conversion target to produce the desired format of the document. Example - aggregate the chapters into a single Markdown file and convert to HTML, ant markdown-to-html Example - aggregate the chapters into a single Markdown file and convert to ODT, ant markdown-to-odt Example - convert a single Markdown chapter file (e.g. 01-intro.markdown) to HTML, ant chapter-to-html -Dchapter=01-intro List all of the ant targets by executing ... ant -projecthelp Note, the Windows specific versions of the targets end in "-win" (e.g. markdown-to-html-win). Override the language property (i.e. lang), specified in the build.properties, by either passing the language value to ant (e.g. -Dlang=es) or by specifying the language in a name/value pair (e.g. lang=es) in your build.<user>.properties. The conversion targets build the results to the respective build directory liferay-docs/<doc.name>/build/<lang>/ Example - build directory for the userGuide in English, liferay-docs/ |____ userGuide/ |____ build/ |____ en/ | |____ userGuide.html | |____ userGuide.markdown | |____ userGuide.odt | |____ images/ (language specific images)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.