Skip to content

Commit

Permalink
Fixed TOC and changed layout and filenames
Browse files Browse the repository at this point in the history
  • Loading branch information
alranel committed May 6, 2014
1 parent ba3b3ec commit 41ee5fe
Show file tree
Hide file tree
Showing 104 changed files with 161 additions and 1,796 deletions.
32 changes: 24 additions & 8 deletions make-html.pl
Expand Up @@ -5,26 +5,34 @@

use List::Util qw(first);

mkdir "html" if !-d "html";
if (defined $ARGV[0] && $ARGV[0] eq '--server') {
chdir 'html';
system qw(python -m SimpleHTTPServer 8000);
exit;
} elsif ($ARGV[0]) {
die "Unknown option\n";
}

system qw(rm -rf html);
mkdir "html";

# convert ToC
system qw(pandoc src/toc.md -f markdown -t html -o html/toc.html);

# convert index page
convert('src/index.md', 'html/index.html');

# convert manual pages
convert_dir("src/$_") for get_subdirs('src');
convert_dir('src');

# copy images and stylesheet
system qw(cp -rf), "src/images", "html/";
system qw(cp html-inc/style.css html/);

sub convert {
my ($md, $html) = @_;

return if $md =~ /\/toc\.md$/;

printf "Converting %s to %s\n", $md, $html;
system 'pandoc', $md, qw(-f markdown -t html -o), $html,
qw(--css style.css --title-prefix), 'Slic3r Manual',
qw(--css /style.css --title-prefix), 'Slic3r Manual',
qw( --include-before-body=html-inc/header.html
--include-before-body=html/toc.html
--include-before-body=html-inc/before-body.html
Expand All @@ -34,8 +42,16 @@ sub convert {
sub convert_dir {
my ($dir) = @_;

foreach my $md (glob "html/*.md") {
my $html_dir = $dir;
$html_dir =~ s{^src(/|$)}{html$1};
mkdir $html_dir;

system qw(cp -r), "$dir/images", "$html_dir/"
if -d "$dir/images";

foreach my $md (glob "$dir/*.md") {
my $html = $md;
$html =~ s{^src/}{html/};
$html =~ s/\.md/.html/;
convert($md, $html);
}
Expand Down
430 changes: 0 additions & 430 deletions src/advanced/AdvancedTopics.md

This file was deleted.

@@ -1,7 +1,4 @@
Command Line Usage
==================


% Command Line Usage

Slic3r can also be used from the command line instead of via the GUI, as
part of a script, or as part of another tool, such as Printrun[^1].
Expand Down
File renamed without changes
@@ -1,7 +1,4 @@
Post-Processing Scripts
=======================


% Post-Processing Scripts

There may be times when the G-Code generated by Slic3r has to be tweaked
or modified after it has been created. For this reason there exists the
Expand All @@ -14,7 +11,7 @@ be added, separated by semicolons. Each scripts should be recognised by
the host system, and be executable.

![Post-processing script
option.](advanced/post_processing_scripts/post_processing_scripts_options.png "fig:")
option.](images/post_processing_scripts/post_processing_scripts_options.png "fig:")


Each script will be passed the absolute path of the G-Code file that
Expand Down
@@ -1,3 +1,5 @@
% Repairing Models

If the 3D mesh described in the model contains holes, or edges are
misaligned (known as being non-manifold), then Slic3r may have problems
working on it. Slic3r will attempt to fix any problems it can, but some
Expand All @@ -14,7 +16,7 @@ faced. Up-to-date instructions can be found on the Netfabb wiki[^2], the
following is a quick overview of the steps involved.

![Netfabb Studio: Part
repair.](working_with_models/netfabb_studio_part_repair.png "fig:")
repair.](images/repair/netfabb_studio_part_repair.png "fig:")


- Start Netfabb Studio, and load the problem STL file, either via the
Expand Down Expand Up @@ -48,7 +50,7 @@ repair.](working_with_models/netfabb_studio_part_repair.png "fig:")
before exporting.

![Netfabb Studio: Part
export.](working_with_models/netfabb_studio_export_part.png "fig:")
export.](images/repair/netfabb_studio_export_part.png "fig:")


#### Netfabb Cloud Service
Expand All @@ -57,7 +59,7 @@ repair.](working_with_models/netfabb_studio_part_repair.png "fig:")
STL file may be uploaded for it to be checked and repaired[^3].

![Netfabb Cloud
Services.](working_with_models/netfabb_cloud_services.png "fig:")
Services.](images/repair/netfabb_cloud_services.png "fig:")


- Navigate to http://cloud.netfabb.com
Expand Down Expand Up @@ -85,7 +87,7 @@ following steps outline how a problem model file can be analysed and
repaired.

![FreeCAD part
repair.](working_with_models/freecad_part_repair.png "fig:")
repair.](images/repair/freecad_part_repair.png "fig:")


- Start FreeCAD and from the start splash page choose
Expand Down
@@ -1,7 +1,4 @@
Sequential Printing
===================


% Sequential Printing

When printing several objects at once it can be useful to print each one
separately as this will minimise oozing and strings running between the
Expand All @@ -10,7 +7,7 @@ print - if one part detaches or fails in some way, it will not be
dragged into other parts of the print during each layer.

![Sequential printing
options.](simple_mode/sequential_printing_options.png "fig:")
options.](images/sequential_printing_options.png "fig:")


Care has to be taken that the nozzle and extruder does not interfere
Expand All @@ -27,5 +24,5 @@ parameters help Slic3r detect potential collisions:
axis rods, or lowest part which may interfere with a finished print.

![The clearance cylinder around an
extruder.](simple_mode/extruder_clearance.jpg "fig:")
extruder.](images/extruder_clearance.jpg "fig:")

13 changes: 5 additions & 8 deletions src/advanced/SVGOutput.md → src/advanced/svg-output.md
@@ -1,7 +1,4 @@
SVG Output
==========


% SVG Output

Slic3r can produce output for other types of 3D printers which require
each layer to be represented as image, for example DLP resin or
Expand All @@ -13,7 +10,7 @@ format, rather than a bitmap format. For this reason it is common to use
Scalable Vector Graphics (SVG) format.

![Example SVG
slice.](advanced/svg_output/example_svg_slice.png "fig:")
slice.](images/svg_output/example_svg_slice.png "fig:")


Slic3r provides the ability to produce SVG output suitable for such
Expand All @@ -28,7 +25,7 @@ first layer being shown, and only the negative islands within the model
(as the browser background is usually white).

![SVG in the
browser.](advanced/svg_output/svg_direct_browser.png "fig:")
browser.](images/svg_output/svg_direct_browser.png "fig:")


For this reason a small web application was written to allow each slice
Expand All @@ -37,7 +34,7 @@ Navigate to the application and drag and drop the SVG file onto the
screen to have it load and display.

![Slic3r SVG
Viewer.](advanced/svg_output/svg_slic3rsvg_viewer.png "fig:")
Viewer.](images/svg_output/svg_slic3rsvg_viewer.png "fig:")


SVG Settings
Expand All @@ -64,7 +61,7 @@ G-Code commands sent through the printcore component, which means that
standard RepRap electronics, such as RAMPS, can be used.

![Printing SVG with
Projectlayer.](advanced/svg_output/projectlayer.png "fig:")
Projectlayer.](images/svg_output/projectlayer.png "fig:")


[^1]: <http://garyhodgson.github.io/slic3rsvgviewer>
Expand Down
@@ -1,3 +1,5 @@
% Configuration Organization

There are two ways in which to organise the configuration settings:
exporting and importing the configuration settings, and profiles. The
former is available in both simple and expert mode, whereas profiles is
Expand Down Expand Up @@ -47,11 +49,11 @@ Open the desired tab and change the settings as necessary. Once
satisfied, click the save icon to the left above the setting titles, and
give a suitable name when prompted.

![Saving a profile.](organising/creating_a_profile.png "fig:")
![Saving a profile.](images/creating_a_profile.png "fig:")


Profiles can be deleted by choosing the profile to delete and clicking
the red delete button next to the save button.

![Deleting a profile.](organising/deleting_a_profile.png "fig:")
![Deleting a profile.](images/deleting_a_profile.png "fig:")

9 changes: 3 additions & 6 deletions src/expert-mode/Cooling.md
@@ -1,7 +1,4 @@
Cooling
=======


% Cooling

Temperature plays a key part in determining print quality. Too hot and
the material deforms, too cool and layer adhesion may be problematic.
Expand All @@ -13,7 +10,7 @@ There are two main techniques for cooling: adding a fan and slowing down
the print speed. Slic3r may choose to use both techniques, using a fan
first, and then slowing down the print if the layer time is too fast.

![Cooling strategy.](expertmode/cooling_chart.png "fig:")
![Cooling strategy.](images/cooling_chart.png "fig:")


Figure shows the strategy adopted by Slic3r.
Expand Down Expand Up @@ -60,7 +57,7 @@ In simple mode Slic3r will attempt to choose the optimal settings for
both fans and speed. Expert mode gives more granular options.

![Cooling advanced
settings.](expertmode/cooling_advanced_settings.png "fig:")
settings.](images/cooling_advanced_settings.png "fig:")


- `Fan speed` - Determines the minimum and maximum speeds - useful for
Expand Down

0 comments on commit 41ee5fe

Please sign in to comment.