Hi Seb, After reading the Getting Started guide and it looks good, my thoughts are that the stepconf and pncconf should only be mentioned in that document and those documents should be in the configuring Linxuxcnc section IMHO. This way links between other configuring documents could be used. I feels right to mention stepconf and pncconf in the next steps in configuration and send them on to the integrators manual at that point. I also think that stepper quickstart should be in the configuring linuxcnc section as well. This would make the getting started document short and sweet and to the point. The getting started would guide you to get the software, install it, and run a sim configuration.
Thanks for working on this Seb. JT On 11/20/2014 11:31 PM, Sebastian Kuzminsky wrote: > docs: support top-level html file > > When asciidoc builds .html files from .txt files, it needs to be told the > location of the .css and .js files that the .html files are going to > reference. > > We used to do this in a way that worked fine for .html files in > subdirectories, but did not work for "top-level" .html files, ie files > living directly in docs/html, generated from .txt files living directly > in docs/src. > > We never knew this because we dont generate any top-level .html files > using asciidoc. > > There were two problems: > > 1. It would miss-compute the relative path for top-level html files, and > use "../" instead of nothing. > > 2. When given a stylesdir or scriptsdir attribute, asciidoc builds the > path as "$DIR/$FILE", which is usually sensible. But asciidoc doesn't > check for an empty $DIR, and mistakenly uses "/$FILE" if given an empty > $DIR. > > This commit fixes the path computation to work in all cases, and changes > the asciidoc arguments so stylesdir and scriptsdir are only supplied if > they're non-empty. > > This makes (future) top-level .html files build correctly, and doesn't > break existing .html files that live in subdirs. > > Signed-off-by: Sebastian Kuzminsky <[email protected]> > > > http://git.linuxcnc.org/?p=linuxcnc.git;a=commitdiff;h=8a0bd68 > > --- > docs/src/Submakefile | 16 +++++++++------- > 1 file changed, 9 insertions(+), 7 deletions(-) > > diff --git a/docs/src/Submakefile b/docs/src/Submakefile > index 76f864f..e0a3518 100644 > --- a/docs/src/Submakefile > +++ b/docs/src/Submakefile > @@ -541,7 +541,12 @@ $(LOC_LANG_MAP): $(wildcard $(LOC_HL_DIR)/*.lang) > $(LANG_MAP) > # the relative path from this html target to the root of the generated > # document tree (docs/html in the git repo). This is where the CSS files > # and javascript files will be installed. > -$(DOC_SRCDIR)/%.html: STYLES_SCRIPTS_DIR=$(shell for i in $(shell dirname $* > | tr '/' '\n' ); do echo -n "../"; done; echo) > +$(DOC_SRCDIR)/%.html: STYLES_SCRIPTS=$(shell \ > + D=$$(python -c "print '../' * '$(shell dirname $*)'.count('/')"); \ > + if [ ! -z $$D ]; then \ > + echo "-a 'scriptsdir=$$D' -a 'stylesdir=$$D'"; \ > + fi \ > +) > > $(patsubst %.txt,$(DOC_SRCDIR)/%.html,$(DOC_SRCS_EN_SMALL)): > $(DOC_SRCDIR)/%.html: $(DOC_SRCDIR)/%.txt objects/xref_en.links > $(LOC_LANG_MAP) > asciidoc -f $(DOC_SRCDIR)/xhtml11.conf \ > @@ -549,8 +554,7 @@ $(patsubst > %.txt,$(DOC_SRCDIR)/%.html,$(DOC_SRCS_EN_SMALL)): $(DOC_SRCDIR)/%.htm > -f $(LOC_HL_DIR)/emc-langs-source-highlight.conf \ > -a "source_highlight_dir=$(LOC_HL_DIR)/local" \ > -a linkcss \ > - -a "scriptsdir=$(STYLES_SCRIPTS_DIR)" \ > - -a "stylesdir=$(STYLES_SCRIPTS_DIR)" \ > + $(STYLES_SCRIPTS) \ > -a "scriptdir=$(DOC_SRCDIR)/" \ > -a "relindir=$(shell dirname $*)" \ > -a "linksfile=objects/xref_en.links" \ > @@ -563,8 +567,7 @@ $(patsubst > %.txt,$(DOC_SRCDIR)/%.html,$(DOC_SRCS_FR_SMALL)): $(DOC_SRCDIR)/%.htm > -f $(LOC_HL_DIR)/emc-langs-source-highlight.conf \ > -a "source_highlight_dir=$(LOC_HL_DIR)/local" \ > -a linkcss \ > - -a "scriptsdir=$(STYLES_SCRIPTS_DIR)" \ > - -a "stylesdir=$(STYLES_SCRIPTS_DIR)" \ > + $(STYLES_SCRIPTS) \ > -a "scriptdir=$(DOC_SRCDIR)/" \ > -a "relindir=$(shell dirname $*)" \ > -a "linksfile=objects/xref_fr.links" \ > @@ -575,8 +578,7 @@ $(patsubst > %.txt,$(DOC_SRCDIR)/%.html,$(DOC_SRCS_ES_SMALL)): $(DOC_SRCDIR)/%.htm > asciidoc -f $(DOC_SRCDIR)/xhtml11.conf \ > -f $(DOC_SRCDIR)/asciidoc-dont-replace-arrows.conf \ > -a linkcss \ > - -a "scriptsdir=$(STYLES_SCRIPTS_DIR)" \ > - -a "stylesdir=$(STYLES_SCRIPTS_DIR)" \ > + $(STYLES_SCRIPTS) \ > -a "scriptdir=$(DOC_SRCDIR)/" \ > -a "relindir=$(shell dirname $*)" \ > -a "linksfile=objects/xref_es.links" \ > > ------------------------------------------------------------------------------ > Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server > from Actuate! Instantly Supercharge Your Business Reports and Dashboards > with Interactivity, Sharing, Native Excel Exports, App Integration & more > Get technology previously reserved for billion-dollar corporations, FREE > http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk > _____________________________________________ > Emc-commit mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/emc-commit ------------------------------------------------------------------------------ Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server from Actuate! Instantly Supercharge Your Business Reports and Dashboards with Interactivity, Sharing, Native Excel Exports, App Integration & more Get technology previously reserved for billion-dollar corporations, FREE http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk _______________________________________________ Emc-developers mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/emc-developers
