Difference between revisions of "Help:Uploading files"

From SoftMC-Wiki
Jump to: navigation, search
(typo)
m
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Uploading files to Manz-Wiki is necessary for two main reasons: An image has to be displayed inside of a page or a document has to be published on Manz-Wiki.
+
<font color="red">
 +
Uploading files to wiki is necessary for two main reasons: An image has to be displayed inside of a page or a document has to be published on the wiki.
 +
</font>
  
−
Every uploaded file gets its own ''File Description Page'' within the ''File'' [[Help:Namespaces|namespace]].
+
Every uploaded file gets its own ''File Description Page'' within the ''File'' [[Help:Namespaces and User Rights|namespace]].
 
On this page file information as file size, upload history and links to the file is displayed.
 
On this page file information as file size, upload history and links to the file is displayed.
−
Furthermore this page can be edited to provide additional information about the document and/or add it to a category.
+
Furthermore this page can be edited to provide additional information about the document and/or add it to a [[Help:Categories|category]].
 +
 
 +
== File names ==
 +
As the File namespace where all files go into is global, a convention on file names is necessary to avoid conflicts.
 +
In most cases name of the public [[Help:Namespaces and User Rights#Namespaces at company|department namespace]] should be used as prefix followed by a semicolon.
 +
If the file is an image and only belongs to a special article also the article name have to be included in the file name.
 +
Note: Semicolon is used here because colons cannot be part of a file name.
 +
 
 +
Version information is not part of the file name. When needed it must be specified as comment in the summary.
 +
 
 +
=== Examples for file names ===
 +
''File:'' is the file namespace, it is set automatically:
 +
* ''File:'''''<u>Control;</u>Article name - image name.png'''
 +
* ''File:'''''<u>Mechatronics;</u>HowTo_calibrate_axes.pdf'''
  
 
[[File:Help - Uploading files - Form.png|600px|right|Uploading files form]]
 
[[File:Help - Uploading files - Form.png|600px|right|Uploading files form]]
Line 18: Line 33:
  
 
;Destination filename
 
;Destination filename
−
: Clear and unique name on wiki. As every wiki page it is case sensitive. For example:
+
: Clear and unique [[#File names|file name]] on wiki.
−
:* ''MyPrettyPageName - NiceImageName.png'' - If it is an image used only in the particular page.
 
−
:* ''HowTo setup external encoder.pdf'' - If this file is a content document itself.
 
−
: Version information should not be part of the file name because new versions will be re-uploaded under the same name. Please specify the uploaded version in the Summary!
 
  
 
;Summary
 
;Summary
Line 30: Line 42:
 
This allows the wiki engine to include it in standard keyword search.
 
This allows the wiki engine to include it in standard keyword search.
 
For now only ''PDF'' file type is supported.
 
For now only ''PDF'' file type is supported.
 +
 +
== File formats ==
 +
;.jpg
 +
:Preferred for photographs.
 +
;.png
 +
:Preferred for screenshots.
  
 
== See also ==
 
== See also ==

Latest revision as of 11:04, 24 April 2014

Uploading files to wiki is necessary for two main reasons: An image has to be displayed inside of a page or a document has to be published on the wiki.

Every uploaded file gets its own File Description Page within the File namespace. On this page file information as file size, upload history and links to the file is displayed. Furthermore this page can be edited to provide additional information about the document and/or add it to a category.

File names

As the File namespace where all files go into is global, a convention on file names is necessary to avoid conflicts. In most cases name of the public department namespace should be used as prefix followed by a semicolon. If the file is an image and only belongs to a special article also the article name have to be included in the file name. Note: Semicolon is used here because colons cannot be part of a file name.

Version information is not part of the file name. When needed it must be specified as comment in the summary.

Examples for file names

File: is the file namespace, it is set automatically:

  • File:Control;Article name - image name.png
  • File:Mechatronics;HowTo_calibrate_axes.pdf
Uploading files form

Quick steps

  1. Go to Upload file in the toolbox on the left.
  2. Fill in the form as seen on the right.
  3. Click on upload file to start the upload.
  4. If needed, edit the file description page to add the document to a category.

Descriptions

Source filename
Source file on the file system. Permitted file types as well as the maximum file size are shown in the upload form below.
Destination filename
Clear and unique file name on wiki.
Summary
Notes for the upload, which will be shown in the upload history. For a document the version and date should be specified.

Searchable documents (PDFs)

If a document type with textual content is uploaded, its content is added as comment to the file description page. This allows the wiki engine to include it in standard keyword search. For now only PDF file type is supported.

File formats

.jpg
Preferred for photographs.
.png
Preferred for screenshots.

See also

Special pages to help you view and manage files which have been uploaded

Retrieved from "http://softmc.servotronix.com/index.php?title=Help:Uploading_files&oldid=116571"